From ec4c49b01e132a1769b5880e4763c31813a5dc23 Mon Sep 17 00:00:00 2001 From: schroda <50052685+schroda@users.noreply.github.com> Date: Sat, 20 Jan 2024 00:11:45 +0100 Subject: [PATCH] Remove default values from readme --- README.md | 65 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 34 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 0d2955d..8da4650 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,9 @@ container. # Environment Variables +> [!NOTE] +> See [server-reference.conf](https://github.com/Suwayomi/Suwayomi-Server/blob/master/server/src/main/resources/server-reference.conf) in the [Suwayomi-Server](https://github.com/Suwayomi/Suwayomi-Server) repository for the default values + > [!Tip] > Settings can be changed during runtime via the webUI. @@ -33,37 +36,37 @@ container. There are a number of environment variables available to configure Suwayomi: -| Variable | Default | Description | -|:--------------------------------:|:----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| **TZ** | `Etc/UTC` | What time zone the container thinks it is. | -| **BIND_IP** | `0.0.0.0` | The interface to listen on, inside the container. You almost never want to change this. | -| **BIND_PORT** | `4567` | Which port Suwayomi will listen on | -| **SOCKS_PROXY_ENABLED** | `false` | Whether Suwayomi will connect through a SOCKS5 proxy | -| **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 | -| **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_ENABLED** | `true` | If the server should serve a webUI | -| **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** | `0` | 0 to disable - how many unread downloaded chapters should be available - if the limit is reached, new chapters won't be downloaded automatically | -| **EXTENSION_REPOS** | `"[]"` | Any additional extension repos to use, the format is `["https://github.com/MY_ACCOUNT/MY_REPO/tree/repo", "https://github.com/MY_ACCOUNT_2/MY_REPO_2/"]` | -| **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 | +| Variable | Description | +|:--------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| **TZ** | What time zone the container thinks it is. | +| **BIND_IP** | The interface to listen on, inside the container. You almost never want to change this. | +| **BIND_PORT** | Which port Suwayomi will listen on | +| **SOCKS_PROXY_ENABLED** | Whether Suwayomi will connect through a SOCKS5 proxy | +| **SOCKS_PROXY_HOST** | The TCP host of the SOCKS5 proxy | +| **SOCKS_PROXY_PORT** | The port of the SOCKS5 proxy | +| **DOWNLOAD_AS_CBZ** | Whether Suwayomi should save the manga to disk in CBZ format | +| **BASIC_AUTH_ENABLED** | 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** | If extra logging is enabled. Useful for development and troubleshooting. | +| **GQL_DEBUG** | If graphql logging is enabled. Useful for development and troubleshooting. Can overload the log output. | +| **WEB_UI_ENABLED** | If the server should serve a webUI | +| **WEB_UI_FLAVOR** | "WebUI" or "Custom" | +| **WEB_UI_CHANNEL** | "bundled" (the version bundled with the server release), "stable" or "preview" - the webUI version that should be used | +| **WEB_UI_UPDATE_INTERVAL** | Time in hours - 0 to disable auto update - range: 1 <= n < 24 - how often the server should check for webUI updates | +| **AUTO_DOWNLOAD_CHAPTERS** | If new chapters that have been retrieved should get automatically downloaded | +| **AUTO_DOWNLOAD_EXCLUDE_UNREAD** | Ignore automatic chapter downloads of entries with unread chapters | +| **AUTO_DOWNLOAD_AHEAD_LIMIT** | 0 to disable - how many unread downloaded chapters should be available - if the limit is reached, new chapters won't be downloaded automatically | +| **EXTENSION_REPOS** | Any additional extension repos to use, the format is `["https://github.com/MY_ACCOUNT/MY_REPO/tree/repo", "https://github.com/MY_ACCOUNT_2/MY_REPO_2/"]` | +| **MAX_SOURCES_IN_PARALLEL** | 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** | If unread manga should be excluded from updates | +| **UPDATE_EXCLUDE_STARTED** | If manga that haven't been started should be excluded from updates | +| **UPDATE_EXCLUDE_COMPLETED** | If completed manga should be excluded from updates | +| **UPDATE_INTERVAL** | 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** | If manga info should be updated along with the chapters | +| **BACKUP_TIME** | Range: hour: 0-23, minute: 0-59 - Time of day at which the automated backup should be triggered | +| **BACKUP_INTERVAL** | # Time in days - 0 to disable it - range: 1 <= n < ∞ - Interval in which the server will automatically create a backup | +| **BACKUP_TTL** | # Time in days - 0 to disable it - range: 1 <= n < ∞ - How long backup files will be kept before they will get deleted | # Docker tags