Configuration Reference
The configuration file is appsettings.json, if not present it will be
created with default values (appsettings-default.json).
Authentication
AuthCookieName
The name of the authorization cookie.
The default value is jwtToken.
AuthProvider
The authentication provider, supported values:
Sqlite: SQLite databaseMysql: MySQL or MariaDB, (compatibility)Mssql: Microsoft SQL Server (no migrations)
The default value is Sqlite
The IdentityConnection connection string should be changed accordingly.
Secret
The secret used as key to generate the JWT tokens. Do not use the same secret for multiple applications.
TokenExpirationInDays
The number of days after which the JWT tokens will expire.
The default value is 7 days.
RevokedTokens
The list of revoked JWT tokens.
ExternalAuthUrl
The URL of the external authentication provider.
The default value is null.
Database
Use MySQL / MariaDB instead of SQLite
For production environments with high load, it's recommended to use MySQL or MariaDB. See the Getting Started guide for setup instructions.
RegistryProvider
The Registry database provider, supported values:
Sqlite: SQLite databaseMysql: MySQL or MariaDB, (compatibility)Mssql: Microsoft SQL Server (no migrations)
The default value is Sqlite
The RegistryConnection connection string should be changed accordingly.
HangfireProvider
The Hangfire provider, supported values:
InMemory: In-memory providerMysql: MySQL or MariaDB
The default value is InMemory
The HangfireConnection connection string should be changed accordingly.
Storage
StoragePath
The path to the storage folder.
The default value is ./data
DatasetsPath
The path to the datasets folder.
The default value is ./datasets
TempPath
The path to the temporary files folder.
The default value is ./temp
CachePath
The path to the cache folder. This is used to store the generated tiles and thumbnails.
The default value is ./cache.
Cache
CacheProvider
The additional cache provider, supported values:
InMemory: In-memory cache provider. Example value:
{ "type": "InMemory" }
Redis: Redis cache provider. Example value:
{
"type": "Redis",
"settings": {
"InstanceAddress": "localhost:5002",
"InstanceName": "registry"
}
}
The default value is null (InMemory is used).
ClearCacheInterval
The interval to clear the file cache (TimeSpan).
The default value is 01:00:00 (1 hour).
ThumbnailsCacheExpiration
The expiration time of the thumbnails cache (TimeSpan).
The default value is 00:30:00 (30 minutes).
TilesCacheExpiration
The expiration time of the tiles cache (TimeSpan).
The default value is 00:30:00 (30 minutes).
VisibilityCacheExpiration
The expiration time for the dataset visibility cache (TimeSpan).
The default value is 1.00:00:00 (1 day).
Upload & Sharing
MaxRequestBodySize
The maximum request body size. It sets the MultipartBodyLengthLimit of the kestrel FormOptions.
The default value is null (default).
BatchTokenLength
The length of the token generated in the share endpoint.
The default value is 32.
RandomDatasetNameLength
The length of the random dataset name, generated when calling the share endpoint.
The default value is 16.
UploadBatchTimeout
The timeout for the share upload endpoint. It is the maximum time allowed between the uploads.
The default value is 01:00:00 (1 hour).
ZipMemoryThreshold
Memory threshold (in bytes) before using disk-based ZIP creation.
The default value is 1073741824 (1 GB)
User Management
DefaultAdmin
The default admin user.
The default value is:
{
"Email": "admin@example.com",
"UserName": "admin",
"Password": "password"
}
EnableStorageLimiter
Enable the storage limiter. Registry will limit the storage usage of the user based on its metadata (maxStorageMB key).
The default value is false.
Networking
ExternalUrlOverride
The external URL of Registry. This is used when the application is behind a reverse proxy.
The default value is null.
Processing
WorkerThreads
The number of worker threads used by the application. Use -1 for automatic detection.
The default value is -1
RemoteThumbGeneratorUrl
URL of a remote thumbnail generator service for offloading thumbnail generation.
The default value is null
Scheduled Jobs
CleanupExpiredJobsCron
Cron expression for the job that cleans up expired jobs.
The default value is 0 * * * * (every hour)
SyncJobStatesCron
Cron expression for the job that synchronizes job states.
The default value is */5 * * * * (every 5 minutes)
ProcessPendingBuildsCron
Cron expression for the job that processes pending builds.
The default value is * * * * * (every minute)
OrphanedDatasetCleanupCron
Cron expression for the job that cleans up orphaned dataset folders. This job runs daily to remove filesystem folders that no longer have a corresponding database entry (e.g., from failed deletions).
The default value is 0 3 * * * (daily at 3:00 AM)