From 233b89a0b115cf28a8ebce5a97edeebe18a089d4 Mon Sep 17 00:00:00 2001 From: Mitchell Syer Date: Fri, 8 Dec 2023 18:48:23 -0500 Subject: [PATCH] Update Configuration Options (#65) * Update Configuration * Fix defualt auto download ahead limit in readme --- README.md | 5 +++-- scripts/startup_script.sh | 5 +++-- server.conf.template | 2 ++ 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bcb8d26..fdf4dc5 100644 --- a/README.md +++ b/README.md @@ -32,22 +32,23 @@ There are a number of environment variables available to configure Suwayomi: | **SOCKS_PROXY_HOST** | `""` | The TCP host of the SOCKS5 proxy | | **SOCKS_PROXY_PORT** | `""` | The port of the SOCKS5 proxy | | **DOWNLOAD_AS_CBZ** | `false` | Whether Suwayomi should save the manga to disk in CBZ format | -| **MAX_PARALLEL_UPDATE** | `10` | How many sources can be updated at the same time? | | **BASIC_AUTH_ENABLED** | `false` | Whether Suwayomi requires HTTP Basic Auth to get in. | | **BASIC_AUTH_USERNAME** | `""` | The username to log in to Suwayomi. | | **BASIC_AUTH_PASSWORD** | `""` | The password to log in to Suwayomi. | | **DEBUG** | `true` | If extra logging is enabled. Useful for development and troubleshooting. | +| **GQL_DEBUG** | `false` | If graphql logging is enabled. Useful for development and troubleshooting. Can overload the log output. | | **WEB_UI_FLAVOR** | `"WebUI"` | "WebUI" or "Custom" | | **WEB_UI_CHANNEL** | `"stable"` | "bundled" (the version bundled with the server release), "stable" or "preview" - the webUI version that should be used | | **WEB_UI_UPDATE_INTERVAL** | `23` | Time in hours - 0 to disable auto update - range: 1 <= n < 24 - how often the server should check for webUI updates | | **AUTO_DOWNLOAD_CHAPTERS** | `false` | If new chapters that have been retrieved should get automatically downloaded | | **AUTO_DOWNLOAD_EXCLUDE_UNREAD** | `true` | Ignore automatic chapter downloads of entries with unread chapters -| **AUTO_DOWNLOAD_AHEAD_LIMIT** | `5` | 0 to disable - how many unread downloaded chapters should be available - if the limit is reached, new chapters won't be downloaded automatically +| **AUTO_DOWNLOAD_AHEAD_LIMIT** | `0` | 0 to disable - how many unread downloaded chapters should be available - if the limit is reached, new chapters won't be downloaded automatically | **MAX_SOURCES_IN_PARALLEL** | `6` | Range: 1 <= n <= 20 - Sets how many sources can do requests (updates, downloads) in parallel. Updates/Downloads are grouped by source and all mangas of a source are updated/downloaded synchronously | | **UPDATE_EXCLUDE_UNREAD** | `true` | If unread manga should be excluded from updates | | **UPDATE_EXCLUDE_STARTED** | `true` | If manga that haven't been started should be excluded from updates | | **UPDATE_EXCLUDE_COMPLETED** | `true` | If completed manga should be excluded from updates | | **UPDATE_INTERVAL** | `12` | Time in hours - 0 to disable it - (doesn't have to be full hours e.g. 12.5) - range: 6 <= n < ∞ - Interval in which the global update will be automatically triggered | +| **UPDATE_MANGA_INFO** | `true` | If manga info should be updated along with the chapters | | **BACKUP_TIME** | `"00:00"` | Range: hour: 0-23, minute: 0-59 - Time of day at which the automated backup should be triggered | | **BACKUP_INTERVAL** | `1` | # Time in days - 0 to disable it - range: 1 <= n < ∞ - Interval in which the server will automatically create a backup | | **BACKUP_TTL** | `14` | # Time in days - 0 to disable it - range: 1 <= n < ∞ - How long backup files will be kept before they will get deleted | diff --git a/scripts/startup_script.sh b/scripts/startup_script.sh index 1d64bf8..c055b70 100755 --- a/scripts/startup_script.sh +++ b/scripts/startup_script.sh @@ -13,22 +13,23 @@ export SOCKS_PROXY_ENABLED="${SOCKS_PROXY_ENABLED:-false}" export SOCKS_PROXY_HOST="${SOCKS_PROXY_HOST:-""}" export SOCKS_PROXY_PORT="${SOCKS_PROXY_PORT:-""}" export DOWNLOAD_AS_CBZ="${DOWNLOAD_AS_CBZ:-false}" -export MAX_PARALLEL_UPDATE="${MAX_PARALLEL_UPDATE:-10}" export BASIC_AUTH_ENABLED="${BASIC_AUTH_ENABLED:-false}" export BASIC_AUTH_USERNAME="${BASIC_AUTH_USERNAME:-""}" export BASIC_AUTH_PASSWORD="${BASIC_AUTH_PASSWORD:-""}" export DEBUG="${DEBUG:-true}" +export GQL_DEBUG="${GQL_DEBUG:-false}" export WEB_UI_FLAVOR="${WEB_UI_FLAVOR:-"WebUI"}" export WEB_UI_CHANNEL="${WEB_UI_CHANNEL:-"stable"}" export WEB_UI_UPDATE_INTERVAL="${WEB_UI_UPDATE_INTERVAL:-23}" export AUTO_DOWNLOAD_CHAPTERS="${AUTO_DOWNLOAD_CHAPTERS:-false}" export AUTO_DOWNLOAD_EXCLUDE_UNREAD="${AUTO_DOWNLOAD_EXCLUDE_UNREAD:-true}" -export AUTO_DOWNLOAD_AHEAD_LIMIT="${AUTO_DOWNLOAD_AHEAD_LIMIT:-5}" +export AUTO_DOWNLOAD_AHEAD_LIMIT="${AUTO_DOWNLOAD_AHEAD_LIMIT:-0}" export MAX_SOURCES_IN_PARALLEL="${MAX_SOURCES_IN_PARALLEL:-6}" export UPDATE_EXCLUDE_UNREAD="${UPDATE_EXCLUDE_UNREAD:-true}" export UPDATE_EXCLUDE_STARTED="${UPDATE_EXCLUDE_STARTED:-true}" export UPDATE_EXCLUDE_COMPLETED="${UPDATE_EXCLUDE_COMPLETED:-true}" export UPDATE_INTERVAL="${UPDATE_INTERVAL:-12}" +export UPDATE_MANGA_INFO="${UPDATE_MANGA_INFO:-false}" export BACKUP_TIME="${BACKUP_TIME:-"00:00"}" export BACKUP_INTERVAL="${BACKUP_INTERVAL:-1}" export BACKUP_TTL="${BACKUP_TTL:-14}" diff --git a/server.conf.template b/server.conf.template index 9675a11..c57cb34 100644 --- a/server.conf.template +++ b/server.conf.template @@ -31,6 +31,7 @@ server.excludeUnreadChapters = ${UPDATE_EXCLUDE_UNREAD} server.excludeNotStarted = ${UPDATE_EXCLUDE_STARTED} server.excludeCompleted = ${UPDATE_EXCLUDE_COMPLETED} server.globalUpdateInterval = ${UPDATE_INTERVAL} # time in hours - 0 to disable it - (doesn't have to be full hours e.g. 12.5) - range: 6 <= n < ∞ - default: 12 hours - interval in which the global update will be automatically triggered +server.updateMangas = ${UPDATE_MANGA_INFO} # Authentication server.basicAuthEnabled = ${BASIC_AUTH_ENABLED} @@ -39,6 +40,7 @@ server.basicAuthPassword = "${BASIC_AUTH_PASSWORD}" # misc server.debugLogsEnabled = ${DEBUG} +server.gqlDebugLogsEnabled = ${GQL_DEBUG} server.systemTrayEnabled = false # backup