LAB-linuxserver/docker-hedgedoc
1
0
Fork 0
mirror of https://github.com/linuxserver/docker-hedgedoc.git synced 2026-03-16 00:01:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #20 from linuxserver/lscr

Browse Source 
Add lscr to custom sample comopse
This commit is contained in:
aptalca 2021-10-17 13:30:59 -04:00 committed by GitHub
commit dfa4f4b9dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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=<secret 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=<secret password> \
-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=<secret password>` | 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

13
readme-vars.yml
View File

@ -27,6 +27,10 @@ param_env_vars:
- { env_var: "DB_PASS", env_value: "<secret password>", 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" }
@ -38,11 +42,11 @@ 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:
- path/to/mariadb/data:/config
- /path/to/mariadb/data:/config
environment:
- MYSQL_ROOT_PASSWORD=<secret password>
- MYSQL_DATABASE=hedgedoc
@ -52,7 +56,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:
@ -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" }