Riven
Core

Settings

RivenSettings

Object containing the following properties:

PropertyDescriptionTypeDefault
databaseUrl (*)The database connection URL.string (url)
databaseDebugLoggingEnable debug logging for the database.booleanfalse
databaseSslRootCertThe file path to the SSL root certificate for the database connection.string
databaseSslCertThe file path to the SSL certificate for the database connection.string
databaseSslKeyThe file path to the SSL key for the database connection.string
redisUrl (*)The Redis server URL.string (url)
vfsDebugLoggingEnable debug logging for the virtual file system.booleanfalse
vfsMountPath (*)The mount point for the virtual file system.string
vfsForceMountIf true, attempts to unmount the mount-point before remounting.booleantrue
unsafeWipeRedisOnStartupUNSAFE.

If true, all Redis data will be removed on application startup.
booleanfalse
unsafeWipeDatabaseOnStartupUNSAFE.

If true, the database will be wiped on application startup.
booleanfalse
unsafeWipeUsersOnStartupUNSAFE.

If true, all user data will be removed on application startup.
booleanfalse
hostThe API server host.string'localhost'
portThe API server port.number (int)3000
shutdownTimeoutSecondsThe timeout in seconds for shutting down the application.number (>0)30
rankingConfigPathPath to the JSON file containing the torrent ranking configuration. Auto-generated with defaults on first startup.string'./riven-ranking-config.json'
printConfigurationOnStartupWhether to print the effective configuration on application startup. Useful for debugging configuration issues.booleanfalse
adminUserCredentials (*)The admin user credentials - in the format username:passwordnever

(*) Required.

On this page