diff --git a/README.md b/README.md index d0ea428..bfa6fbc 100644 --- a/README.md +++ b/README.md @@ -22,14 +22,14 @@ Use the template [docker-compose.yml](./docker-compose.yml) in this repo for cre # 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 +> [!CAUTION] +> Providing an environment variable will overwrite the current setting value when starting the container. > [!Tip] -> Settings can be changed during runtime via the webUI. +> Most of the time you don't need to use environment variables, instead settings can be changed during runtime via the webUI. (which will be rendered useless when providing an environment variable) -> [!CAUTION] -> Providing an environment variable will overwrite the current value in the server.conf file. +> [!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 There are a number of environment variables available to configure Suwayomi: diff --git a/docker-compose.yml b/docker-compose.yml index 81e0b1e..a415398 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -5,17 +5,26 @@ services: image: ghcr.io/suwayomi/tachidesk:preview environment: - TZ=Etc/UTC # Use TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones - - DEBUG=true - - BIND_IP=0.0.0.0 - - BIND_PORT=4567 - - SOCKS_PROXY_ENABLED=false - - DOWNLOAD_AS_CBZ=true - - MAX_PARALLEL_UPDATE=3 - - BASIC_AUTH_ENABLED=true - - BASIC_AUTH_USERNAME=manga - - BASIC_AUTH_PASSWORD=hello123 - - FLARESOLVERR_ENABLED=true - - FLARESOLVERR_URL="http://flaresolverr:8191" +# ################################################################################################# +# +# !!! IMPORTANT !!! +# - server settings can be changed during runtime in the WebUI +# - providing an environment variable will OVERWRITE the current setting value when starting the container +# +# ################################################################################################# +# +# example for setting env vars: +# +# - BIND_IP=0.0.0.0 +# - BIND_PORT=4567 +# - SOCKS_PROXY_ENABLED=false +# - DOWNLOAD_AS_CBZ=true +# - BASIC_AUTH_ENABLED=true +# - BASIC_AUTH_USERNAME=manga +# - BASIC_AUTH_PASSWORD=hello123 +# - EXTENSION_REPOS=["http://github.com/orginazation-name/repo-name", "http://github.com/orginazation-name-2/repo-name-2"] +# - FLARESOLVERR_ENABLED=true +# - FLARESOLVERR_URL=http://flaresolverr:8191 volumes: - ./data:/home/suwayomi/.local/share/Tachidesk ports: