Update Config with latest Server Config (#46)

* Update server.conf.template

* Update startup_script.sh

* Update startup_script.sh

* Update server.conf.template

* Update README.md

* Update README.md

* Update README.md
This commit is contained in:
Mitchell Syer
2023-08-15 17:45:45 -04:00
committed by GitHub
parent 51dcfa9d68
commit 741765aadd
3 changed files with 46 additions and 5 deletions

View File

@@ -37,6 +37,18 @@ There are a number of environment variables available to configure Suwayomi:
| **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. |
| **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 |
| **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 |
| **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 |
# Docker tags

View File

@@ -18,6 +18,18 @@ 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 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 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 BACKUP_TIME="${BACKUP_TIME:-"00:00"}"
export BACKUP_INTERVAL="${BACKUP_INTERVAL:-1}"
export BACKUP_TTL="${BACKUP_TTL:-14}"
envsubst < /home/suwayomi/server.conf.template > /home/suwayomi/.local/share/Tachidesk/server.conf

View File

@@ -3,24 +3,32 @@ server.ip = "${BIND_IP}"
server.port = ${BIND_PORT}
# Socks5 proxy
server.socksProxy = ${SOCKS_PROXY_ENABLED}
server.socksProxyEnabled = ${SOCKS_PROXY_ENABLED}
server.socksProxyHost = "${SOCKS_PROXY_HOST}"
server.socksProxyPort = "${SOCKS_PROXY_PORT}"
# webUI
server.webUIEnabled = true
server.webUIFlavor = "WebUI" # "WebUI" or "Custom"
server.webUIFlavor = "${WEB_UI_FLAVOR}" # "WebUI" or "Custom"
server.initialOpenInBrowserEnabled = false
server.webUIInterface = "browser" # "browser" or "electron"
server.electronPath = ""
server.webUIChannel = "${WEB_UI_CHANNEL}" # "bundled" (the version bundled with the server release), "stable" or "preview" - the webUI version that should be used
server.webUIUpdateCheckInterval = ${WEB_UI_UPDATE_INTERVAL} # time in hours - 0 to disable auto update - range: 1 <= n < 24 - default 23 hours - how often the server should check for webUI updates
# downloader
server.downloadAsCbz = ${DOWNLOAD_AS_CBZ}
server.downloadsPath = ""
server.autoDownloadNewChapters = ${AUTO_DOWNLOAD_CHAPTERS} # if new chapters that have been retrieved should get automatically downloaded
# requests
server.maxSourcesInParallel = ${MAX_SOURCES_IN_PARALLEL} # range: 1 <= n <= 20 - default: 6 - 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
# updater
# sets how many sources can be updated in parallel. updates are grouped by source and all mangas of a source are updated synchronously
server.maxParallelUpdateRequests = ${MAX_PARALLEL_UPDATE}
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
# Authentication
server.basicAuthEnabled = ${BASIC_AUTH_ENABLED}
@@ -29,4 +37,13 @@ server.basicAuthPassword = "${BASIC_AUTH_PASSWORD}"
# misc
server.debugLogsEnabled = ${DEBUG}
server.systemTrayEnabled = false # always disabled as we are in a headless container
server.systemTrayEnabled = false
# backup
server.backupPath = ""
server.backupTime = "${BACKUP_TIME}" # range: hour: 0-23, minute: 0-59 - default: "00:00" - time of day at which the automated backup should be triggered
server.backupInterval = ${BACKUP_INTERVAL} # time in days - 0 to disable it - range: 1 <= n < ∞ - default: 1 day - interval in which the server will automatically create a backup
server.backupTTL = ${BACKUP_TTL} # time in days - 0 to disable it - range: 1 <= n < ∞ - default: 14 days - how long backup files will be kept before they will get deleted
# local source
server.localSourcePath = ""