Hedgedoc

Container

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.

Image details

Pulls: 578k

Architecture: amd64, arm64

Image size: 165 MB

Latest: 1.11.1

User: linuxserver

Created: Dec 24, 2020

Updated: 10 days ago

Status: active

Configuration

Type

Container

Platform

linux

Image

linuxserver/hedgedoc:latest

Ports

3000:3000/tcp

Volumes

/config : /srv/lsio/hedgedoc/config

Env vars

PUID=1000PGID=1000TZ=Etc/UTCDB_HOST=<hostname or ip>DB_PORT=3306DB_USER=hedgedocDB_PASS=<secret password>DB_NAME=hedgedocCMD_DOMAIN=localhostCMD_URL_ADDPORT=falseCMD_PROTOCOL_USESSL=falseCMD_PORT=3000CMD_ALLOW_ORIGIN=['localhost']CMD_DB_DIALECT=

Restart

unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/hedgedoc/config

Standalone Install

Select an install method, to see config/commands for deploying Hedgedoc

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select Hedgedoc, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

More install options in our documentation.

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

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-\
arm64	✅	arm64v8-\

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 CMDDOMAIN, CMDPORT and CMDURLADDPORT)
Full list of HedgeDoc options
For convenience we provide a working example using Mariadb as a backend in this document.
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.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  hedgedoc:
    image: lscr.io/linuxserver/hedgedoc:latest
    container_name: hedgedoc
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - "DB_HOST=<hostname or ip>"
      - DB_PORT=3306
      - DB_USER=hedgedoc
      - "DB_PASS=<secret password>"
      - DB_NAME=hedgedoc
      - CMD_DOMAIN=localhost
      - CMD_URL_ADDPORT=false #optional
      - CMD_PROTOCOL_USESSL=false #optional
      - CMD_PORT=3000 #optional
      - CMD_ALLOW_ORIGIN=['localhost'] #optional
      - CMD_DB_DIALECT= #optional
    volumes:
      - /path/to/hedgedoc/config:/config
    ports:
      - 3000:3000
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=hedgedoc \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e DB_HOST="<hostname or ip>" \
  -e DB_PORT=3306 \
  -e DB_USER=hedgedoc \
  -e DB_PASS="<secret password>" \
  -e DB_NAME=hedgedoc \
  -e CMD_DOMAIN=localhost \
  -e CMD_URL_ADDPORT=false `#optional` \
  -e CMD_PROTOCOL_USESSL=false `#optional` \
  -e CMD_PORT=3000 `#optional` \
  -e CMD_ALLOW_ORIGIN=['localhost'] `#optional` \
  -e CMD_DB_DIALECT= `#optional` \
  -p 3000:3000 \
  -v /path/to/hedgedoc/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/hedgedoc:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Parameter	Function
`-p 3000:3000`	Web gui port (internal port also needs to be changed if accessing at port other than 80, 443 and 3000).
`-e PUID=1000`	for UserID - see below for explanation
`-e PGID=1000`	for GroupID - see below for explanation
`-e TZ=Etc/UTC`	specify a timezone to use, see this list.
`-e DBHOST=<hostname or ip>`	Host address of mariadb database
`-e DBPORT=3306`	Port to access mariadb database default is 3306
`-e DBUSER=hedgedoc`	Database user
`-e DBPASS=<secret password>`	Database password
`-e DBNAME=hedgedoc`	Database name
`-e CMDDOMAIN=localhost`	The address the gui will be accessed at (ie. `192.168.1.1` or `hedgedoc.domain.com`).
`-e CMDURLADDPORT=false`	Set to `true` if using a port other than `80` or `443`.
`-e CMDPROTOCOLUSESSL=false`	Set to `true` if accessing over https via reverse proxy.
`-e CMDPORT=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. `CMDPORT=5000`) and change the port mapping accordingly (5000:5000).
`-e CMDALLOWORIGIN='localhost'`	Comma-separated list of allowed hostnames
`-e CMDDBDIALECT=`	This variable allows selecting a database engine (if DBHOST not set up). Available options are: `mariadb`, `mysql`, `postgres`, `sqlite`.
`-v /config`	Persistent config files

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

Shell access whilst the container is running:

```bash
docker exec -it hedgedoc /bin/bash
```

To monitor the logs of the container in realtime:

```bash
docker logs -f hedgedoc
```

Container version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' hedgedoc
```

Image version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hedgedoc:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull hedgedoc
    ```

Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d hedgedoc
    ```

You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

Update the image:

```bash
docker pull lscr.io/linuxserver/hedgedoc:latest
```

Stop the running container:

```bash
docker stop hedgedoc
```

Delete the container:

```bash
docker rm hedgedoc
```

Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-hedgedoc.git
cd docker-hedgedoc
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/hedgedoc:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
29.07.26: - Rebase to Alpine 3.24.
14.10.25: - Rebase to Alpine 3.22.
24.02.25: - Add missing icu-data-full to fix bug with TextDecoder and image uploads.
21.06.24: - Allow using CMD_DB_DIALECT to set up the CMD_DB_URL.
06.06.24: - Rebase to Alpine 3.20.
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

Serve Hedgedoc on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying hedgedoc.example.com to http://Hedgedoc:3000

Add this to your Caddyfile

hedgedoc.example.com {
	reverse_proxy http://Hedgedoc:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs Hedgedoc
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3000 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :3000
Stop the other service, or pick a different host port. In 3000:3000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

Use your server's real IP: http://your-server-ip:3000. The 0.0.0.0 link Portainer shows isn't a real address.
Give it a minute after first deploy, Hedgedoc can take a while to initialise.
Make sure your firewall allows the port, e.g. sudo ufw allow 3000

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/hedgedoc/config
Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/hedgedoc:latest

"manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

This image supports: amd64, arm64
Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

Check the logs right after a restart, the last few lines before it died are the useful ones.
Get the exit code with docker inspect Hedgedoc --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

CMD_DB_DIALECT has no default value, and Hedgedoc may crash or misbehave if left empty.

Fill it in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue within Hedgedoc's repo
Template not working: Open an issue on technorabilia/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

A single container

Hedgedoc runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Hedgedoc needs bundled into one download. This template pulls linuxserver/hedgedoc:latest, which Docker fetches once (about 165 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Hedgedoc's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 1.11.1. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 3000:3000 means it's reachable on port 3000 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3000 in a browser. It opens:

3000:3000, likely the web interface

Volumes

A volume is where Hedgedoc keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

/config from /srv/lsio/hedgedoc/config on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Hedgedoc takes 14 of them, and one needs a value before it'll start properly:

PUID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.
PGID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.
TZ, defaults to Etc/UTC. Specify a timezone to use, see this list.
DB_HOST, defaults to <hostname or ip>. Host address of mariadb database
DB_PORT, defaults to 3306. Port to access mariadb database default is 3306
DB_USER, defaults to hedgedoc. Database user
DB_PASS, defaults to <secret password>. Database password
DB_NAME, defaults to hedgedoc. Database name
CMD_DOMAIN, defaults to localhost. The address the gui will be accessed at (ie. 192.168.1.1 or hedgedoc.domain.com).
CMD_URL_ADDPORT, defaults to false. Set to true if using a port other than 80 or 443. [OPTIONAL]
CMD_PROTOCOL_USESSL, defaults to false. Set to true if accessing over https via reverse proxy. [OPTIONAL]
CMD_PORT, defaults to 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. CMDPORT=5000) and change the port mapping accordingly (5000:5000). [OPTIONAL]
CMD_ALLOW_ORIGIN, defaults to ['localhost']. Comma-separated list of allowed hostnames [OPTIONAL]
CMD_DB_DIALECT, needs a value. This variable allows selecting a database engine (if DBHOST not set up). Available options are: mariadb, mysql, postgres, sqlite. [OPTIONAL]

Restart policy

The restart policy here is unless-stopped, so Docker restarts Hedgedoc after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Hedgedoc sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container Hedgedoc. That's what you'll spot in the containers list and use in commands like docker logs Hedgedoc.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Hedgedoc up. Add the template list to Portainer once, then deploying Hedgedoc is a click rather than a wall of config.

Hedgedoc

Image details

Configuration

Notes

Standalone Install

Install on Portainer

Template Import URL

Container Documentation

linuxserver/hedgedoc

Supported Architectures

Application Setup

Usage

docker-compose (recommended, click here for more info)

docker cli (click here for more info)

Parameters

Environment variables from files (Docker secrets)

Umask for running applications

User / Group Identifiers

Docker Mods

Support Info

Updating Info

Via Docker Compose

Via Docker Run

Image Update Notifications - Diun (Docker Image Update Notifier)

Building locally

Versions

Recent versions

Proxy configurator

Troubleshooting

Check the logs first

Port already in use

Running but the page won't load

Permission denied on volumes

Image won't pull

"exec format error"

Container keeps restarting

Required settings are blank

Raise an issue

Config glossary

A single container

The app image

Where the image comes from

Version tags

Which machines it runs on

Ports

Volumes

Environment variables

Restart policy

Users and permissions

Networking

Container name

Platform

Portainer app templates

Similar apps