Bot Updating Documentation

pull/52/head
LinuxServer-CI 2022-02-09 22:36:06 +01:00
rodzic 8ee0d10055
commit be52726c61
1 zmienionych plików z 7 dodań i 2 usunięć

Wyświetl plik

@ -37,7 +37,7 @@ The architectures supported by this image are:
## Application Setup
HedgeDoc web interface can be accessed `http://${IP}:3000/`, if you want to use a custom domain or anything besides port 3000 you will need to leverage their env settings for callbacks: (specifically for CMD_DOMAIN and CMD_URL_ADDPORT)
HedgeDoc web interface can be accessed `http://${IP}:3000/`, if you want to use a custom domain or anything besides port 3000 you will need to leverage their env settings for callbacks: (specifically for CMD_DOMAIN, CMD_PORT and CMD_URL_ADDPORT)
[Full list of HedgeDoc options](https://docs.hedgedoc.org/configuration/)
@ -87,6 +87,8 @@ services:
- TZ=Europe/London
- CMD_DOMAIN=localhost
- CMD_URL_ADDPORT=true #optional
- CMD_PROTOCOL_USESSL=false #optional
- CMD_PORT=3000 #optional
ports:
- "3000:3000"
@ -108,6 +110,7 @@ docker run -d \
-e CMD_DOMAIN=localhost \
-e CMD_URL_ADDPORT=true `#optional` \
-e CMD_PROTOCOL_USESSL=false `#optional` \
-e CMD_PORT=3000 `#optional` \
-p 3000:3000 \
-v /path/to/appdata:/config \
--restart unless-stopped \
@ -122,7 +125,7 @@ Docker images are configured using parameters passed at runtime (such as those a
| Parameter | Function |
| :----: | --- |
| `3000` | If you wish to access this container from http://{IP}:${PORT}` this *must* be left unchanged. |
| `3000` | Web gui port (internal port also needs to be changed if accessing at port other than 80, 443 and 3000). |
### Environment Variables (`-e`)
@ -139,6 +142,7 @@ Docker images are configured using parameters passed at runtime (such as those a
| `CMD_DOMAIN=localhost` | The address the gui will be accessed at (ie. `192.168.1.1` or `hedgedoc.domain.com`). |
| `CMD_URL_ADDPORT=true` | Set to `false` if accessing at port `80` or `443`. |
| `CMD_PROTOCOL_USESSL=false` | Set to `true` if accessing over https via reverse proxy. |
| `CMD_PORT=3000` | If you wish to access hedgedoc at a port different than 80, 443 or 3000, you need to set this to that port (ie. `CMD_PORT=5000`) and change the port mapping accordingly (5000:5000). |
### Volume Mappings (`-v`)
@ -200,6 +204,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
## Versions
* **09.02.22:** - Add optional var `CMD_PORT` that is needed for accessing at port other than 80, 443 and 3000.
* **09.12.21:** - Add optional var `CMD_PROTOCOL_USESSL` that is needed for reverse proxy.
* **07.12.21:** - Rebase to ubuntu focal. Update to node 16. Make sure uploads are persistent.
* **15.10.21:** - Add required env var `CMD_DOMAIN`.