diff --git a/README.md b/README.md index 9ea4dbb..b2ea0e7 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,8 @@ services: - PUID=1000 - PGID=1000 - TZ=Europe/London - - DOCKER_MODS=linuxserver/calibre-web:calibre + - DOCKER_MODS=linuxserver/calibre-web:calibre #optional + - OAUTHLIB_RELAX_TOKEN_SCOPE=1 #optional volumes: - /path/to/data:/config - /path/to/calibre/library:/books @@ -133,7 +134,8 @@ docker run -d \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Europe/London \ - -e DOCKER_MODS=linuxserver/calibre-web:calibre \ + -e DOCKER_MODS=linuxserver/calibre-web:calibre `#optional` \ + -e OAUTHLIB_RELAX_TOKEN_SCOPE=1 `#optional` \ -p 8083:8083 \ -v /path/to/data:/config \ -v /path/to/calibre/library:/books \ @@ -152,6 +154,7 @@ Container images are configured using parameters passed at runtime (such as thos | `-e PGID=1000` | for GroupID - see below for explanation | | `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. | | `-e DOCKER_MODS=linuxserver/calibre-web:calibre` | #optional & **x86-64 only** Adds the ability to perform ebook conversion | +| `-e OAUTHLIB_RELAX_TOKEN_SCOPE=1` | Optionally set this to allow Google OAUTH to work | | `-v /config` | Where calibre-web stores the internal database and config. | | `-v /books` | Where your preexisting calibre database is located. | @@ -264,6 +267,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions +* **24.06.21:** - Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support. * **17.05.21:** - Add linuxserver wheel index. * **10.02.21:** - Add libxrandr2 * **25.01.21:** - Add nightly tag diff --git a/readme-vars.yml b/readme-vars.yml index 40522a3..6bd0a8f 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -28,7 +28,6 @@ param_container_name: "{{ project_name }}" param_usage_include_env: true param_env_vars: - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." } - - { env_var: "DOCKER_MODS", env_value: "linuxserver/calibre-web:calibre", desc: "#optional & **x86-64 only** Adds the ability to perform ebook conversion"} param_usage_include_vols: true param_volumes: - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "Where calibre-web stores the internal database and config." } @@ -38,7 +37,10 @@ param_ports: - { external_port: "8083", internal_port: "8083", port_desc: "WebUI" } # optional container parameters -opt_param_usage_include_env: false +opt_param_usage_include_env: true +opt_param_env_vars: + - { env_var: "DOCKER_MODS", env_value: "linuxserver/calibre-web:calibre", desc: "#optional & **x86-64 only** Adds the ability to perform ebook conversion"} + - { env_var: "OAUTHLIB_RELAX_TOKEN_SCOPE", env_value: "1", desc: "Optionally set this to allow Google OAUTH to work" } opt_param_usage_include_vols: false opt_param_usage_include_ports: false opt_param_device_map: false @@ -77,6 +79,7 @@ app_setup_block: | # changelog changelogs: + - { date: "24.06.21:", desc: "Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support."} - { date: "17.05.21:", desc: "Add linuxserver wheel index."} - { date: "10.02.21:", desc: "Add libxrandr2"} - { date: "25.01.21:", desc: "Add nightly tag"}