linuxserver/hedgedoc¶
HedgeDoc gives you access to all your files wherever you are.
HedgeDoc is a real-time, multi-platform collaborative markdown note editor. This means that you can write notes with other people on your desktop, tablet or even on the phone. You can sign-in via multiple auth providers like Facebook, Twitter, GitHub and many more on the homepage.
Supported Architectures¶
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/hedgedoc:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
| Architecture | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
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, CMD_PORT and CMD_URL_ADDPORT)
For convience we provide a working example using Mysql as a backend in this document, if you do not wish to use our custom environment values or a Mysql database backend feel free to leverage any of the settings laid out in the link above.
To run behind a reverse proxy we have a preconfigured config using docker networking included in our SWAG image and you can read how to use this in the Reverse Proxy Confs repository
Usage¶
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)¶
---
+ hedgedoc - LinuxServer.io linuxserver/hedgedoc¶
HedgeDoc gives you access to all your files wherever you are.
HedgeDoc is a real-time, multi-platform collaborative markdown note editor. This means that you can write notes with other people on your desktop, tablet or even on the phone. You can sign-in via multiple auth providers like Facebook, Twitter, GitHub and many more on the homepage.
Supported Architectures¶
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/hedgedoc:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
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, CMD_PORT and CMD_URL_ADDPORT)
For convience we provide a working example using Mysql as a backend in this document, if you do not wish to use our custom environment values or a Mysql database backend feel free to leverage any of the settings laid out in the link above.
To run behind a reverse proxy we have a preconfigured config using docker networking included in our SWAG image and you can read how to use this in the Reverse Proxy Confs repository
Usage¶
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)¶
---
services:
hedgedoc:
image: lscr.io/linuxserver/hedgedoc:latest
@@ -64,4 +64,4 @@
--pull \
-t lscr.io/linuxserver/hedgedoc:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 23.12.23: - Rebase to Alpine 3.19.
- 18.06.23: - Rebase to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 10.04.22: - Use python3 to build node sqlite3.
- 10.02.22: - Rebase to Alpine 3.15.
- 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. - 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
\ No newline at end of file
+Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 23.12.23: - Rebase to Alpine 3.19.
- 18.06.23: - Rebase to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 10.04.22: - Use python3 to build node sqlite3.
- 10.02.22: - Rebase to Alpine 3.15.
- 09.02.22: - Add optional var
CMD_PORTthat is needed for accessing at port other than 80, 443 and 3000. - 09.12.21: - Add optional var
CMD_PROTOCOL_USESSLthat 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. - 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