From 7084c3639e742df160530b13900e669ecce549c9 Mon Sep 17 00:00:00 2001 From: Adam Date: Fri, 15 Oct 2021 21:42:33 +0100 Subject: [PATCH 1/2] Add lscr to custom sample comopse --- readme-vars.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme-vars.yml b/readme-vars.yml index bf53b59..81cb136 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -38,7 +38,7 @@ custom_compose: | version: "3" services: mariadb: - image: ghcr.io/linuxserver/mariadb:latest + image: lscr.io/linuxserver/mariadb:latest container_name: hedgedoc_mariadb restart: always volumes: @@ -52,7 +52,7 @@ custom_compose: | - PUID=1000 - TZ=Europe/London hedgedoc: - image: ghcr.io/linuxserver/hedgedoc:latest + image: lscr.io/linuxserver/hedgedoc:latest container_name: hedgedoc restart: always depends_on: From ce2f2dda934a74eefd31b337546e4bbc2a5a93ce Mon Sep 17 00:00:00 2001 From: aptalca Date: Fri, 15 Oct 2021 17:10:35 -0400 Subject: [PATCH 2/2] add new vars --- README.md | 13 ++++++++++--- readme-vars.yml | 9 ++++++++- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d8edc57..5c108c5 100644 --- a/README.md +++ b/README.md @@ -79,11 +79,11 @@ Here are some example snippets to help you get started creating a container. version: "3" services: mariadb: - image: ghcr.io/linuxserver/mariadb:latest + image: lscr.io/linuxserver/mariadb:latest container_name: hedgedoc_mariadb restart: always volumes: - - path/to/mariadb/data:/config + - /path/to/mariadb/data:/config environment: - MYSQL_ROOT_PASSWORD= - MYSQL_DATABASE=hedgedoc @@ -93,7 +93,7 @@ services: - PUID=1000 - TZ=Europe/London hedgedoc: - image: ghcr.io/linuxserver/hedgedoc:latest + image: lscr.io/linuxserver/hedgedoc:latest container_name: hedgedoc restart: always depends_on: @@ -109,6 +109,8 @@ services: - PGID=1000 - PUID=1000 - TZ=Europe/London + - CMD_DOMAIN=localhost + - CMD_URL_ADDPORT=true #optional ports: - "3000:3000" @@ -127,6 +129,8 @@ docker run -d \ -e DB_PASS= \ -e DB_NAME=hedgedoc \ -e TZ=Europe/London \ + -e CMD_DOMAIN=localhost \ + -e CMD_URL_ADDPORT=true `#optional` \ -p 3000:3000 \ -v /path/to/appdata:/config \ --restart unless-stopped \ @@ -148,6 +152,8 @@ Container images are configured using parameters passed at runtime (such as thos | `-e DB_PASS=` | Database password | | `-e DB_NAME=hedgedoc` | Database name | | `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. | +| `-e CMD_DOMAIN=localhost` | The address the gui will be accessed at (ie. `192.168.1.1` or `hedgedoc.domain.com`). | +| `-e CMD_URL_ADDPORT=true` | Set to `false` if accessing at port `80` or `443`. | | `-v /config` | HedgeDoc config and configurable files | ## Environment variables from files (Docker secrets) @@ -259,6 +265,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions +* **15.10.21:** - Add required env var `CMD_DOMAIN`. * **05.05.21:** - Remove symlinking some folders from config to /opt/hedgedoc/public. * **03.05.21:** - Remove deprecated sequalizerc step. * **22.12.20:** - Initial release diff --git a/readme-vars.yml b/readme-vars.yml index 81cb136..dcb70a3 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -27,6 +27,10 @@ param_env_vars: - { env_var: "DB_PASS", env_value: "", desc: "Database password" } - { env_var: "DB_NAME", env_value: "hedgedoc", desc: "Database name" } - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." } + - { env_var: "CMD_DOMAIN", env_value: "localhost", desc: "The address the gui will be accessed at (ie. `192.168.1.1` or `hedgedoc.domain.com`)." } +opt_param_usage_include_env: true +opt_param_env_vars: + - { env_var: "CMD_URL_ADDPORT", env_value: "true", desc: "Set to `false` if accessing at port `80` or `443`." } param_usage_include_vols: true param_volumes: - { vol_path: "/config", vol_host_path: "/path/to/appdata", desc: "HedgeDoc config and configurable files" } @@ -42,7 +46,7 @@ custom_compose: | container_name: hedgedoc_mariadb restart: always volumes: - - path/to/mariadb/data:/config + - /path/to/mariadb/data:/config environment: - MYSQL_ROOT_PASSWORD= - MYSQL_DATABASE=hedgedoc @@ -68,6 +72,8 @@ custom_compose: | - PGID=1000 - PUID=1000 - TZ=Europe/London + - CMD_DOMAIN=localhost + - CMD_URL_ADDPORT=true #optional ports: - "3000:3000" @@ -85,6 +91,7 @@ app_setup_block: | # changelog changelogs: + - { date: "15.10.21:", desc: "Add required env var `CMD_DOMAIN`." } - { date: "05.05.21:", desc: "Remove symlinking some folders from config to /opt/hedgedoc/public." } - { date: "03.05.21:", desc: "Remove deprecated sequalizerc step." } - { date: "22.12.20:", desc: "Initial release" }