Core
Settings
RivenSettings
Object containing the following properties:
| Property | Description | Type | Default |
|---|---|---|---|
attemptUnknownDownloads | If true, Riven will attempt to download torrents whose contents cannot be verified without first attempting to download. Note: Enabling this will degrade performance as more download attempts will be made for all items, however it may be useful to enable if Riven's plugins are unable to find your requested items. | boolean | false |
databaseUrl (*) | The database connection URL. | string (url) | |
databaseDebugLogging | Enable debug logging for the database. | boolean | false |
databaseSslRootCert | The file path to the SSL root certificate for the database connection. | string | |
databaseSslCert | The file path to the SSL certificate for the database connection. | string | |
databaseSslKey | The file path to the SSL key for the database connection. | string | |
redisUrl (*) | The Redis server URL. | string (url) | |
vfsDebugLogging | Enable debug logging for the virtual file system. | boolean | false |
vfsMountPath (*) | The mount point for the virtual file system. | string | |
vfsForceMount | If true, attempts to unmount the mount-point before remounting. | boolean | true |
unsafeWipeRedisOnStartup | UNSAFE. If true, all Redis data will be removed on application startup. | boolean | false |
unsafeWipeDatabaseOnStartup | UNSAFE. If true, the database will be wiped on application startup. | boolean | false |
enabledLogTransports | The enabled logging transports. | Array<'console' | 'file'> | ["console","file"] |
loggingEnabled | Enable or disable logging for the application. | boolean | true |
logLevel | The logging level for the application. | 'error' | 'warn' | 'info' | 'http' | 'verbose' | 'debug' | 'silly' | 'info' |
logDirectory | The directory where log files will be stored. | string | './logs' |
logShowStackTraces | Whether to show detailed stack traces when logging errors | boolean | true |
gqlHost | The GraphQL server host. | string | 'localhost' |
gqlPort | The GraphQL server port. | number (int) | 3000 |
dubbedAnimeOnly | Only scrape dubbed anime. | boolean | false |
maximumScrapeAttempts | The maximum number of scrape attempts before giving up on an item. | number (≥0) | 9007199254740991 |
minimumAverageBitrateMovies | The minimum average bitrate for movies. | number (>0) | |
minimumAverageBitrateEpisodes | The minimum average bitrate for episodes. | number (>0) | |
preferSeasonPacks | If true, Riven will prefer to download season packs over show packs. | boolean | false |
scheduleOffsetMinutes | The number of minutes to wait after an item's air date before attempting to re-index it. | number (≥0) | 30 |
scrapeCooldownHours | The cooldown periods (in hours) to apply after failed scrape attempts, in the format [> 2 attempts, > 5 attempts, > 10 attempts]. | Tuple:
| [2,6,24] |
unknownAirDateOffsetDays | When an episode has no air date, this number of days will be added to the current date to estimate a release date for scheduling purposes. | number (≥0) | 7 |
enabledPlugins | A list of core plugins to enable. | Array<'comet' | 'jellyfin' | 'listrr' | 'mdblist' | 'notifications' | 'plex' | 'seerr' | 'stremthru' | 'subdl' | 'tmdb' | 'torrentio' | 'tvdb'> | [] |
shutdownTimeoutSeconds | The timeout in seconds for shutting down the application. | number (>0) | 30 |
rankingConfigPath | Path to the JSON file containing the torrent ranking configuration. Auto-generated with defaults on first startup. | string | './riven-ranking-config.json' |
printConfigurationOnStartup | Whether to print the effective configuration on application startup. Useful for debugging configuration issues. | boolean | false |
(*) Required.