Portainer Templates logo

Portainer Templates

Hedgedoc Hedgedoc

Content Management

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: 574k
Architectures: amd64, arm64
Image size: 160 MB
Latest: 1.11.0
User: linuxserver
Created: Dec 24, 2020
Updated: 5 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

Installation

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

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

docker run -d --name Hedgedoc \
  -p 3000:3000/tcp \
  -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' \
  -e 'CMD_PROTOCOL_USESSL=false' \
  -e 'CMD_PORT=3000' \
  -e 'CMD_ALLOW_ORIGIN=['\''localhost'\'']' \
  -e 'CMD_DB_DIALECT=' \
  -v /srv/lsio/hedgedoc/config:/config \
  --restart=unless-stopped \
  linuxserver/hedgedoc:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  hedgedoc:
    image: linuxserver/hedgedoc:latest
    ports:
      - 3000:3000/tcp
    volumes:
      - /srv/lsio/hedgedoc/config:/config
    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'
      CMD_PROTOCOL_USESSL: 'false'
      CMD_PORT: '3000'
      CMD_ALLOW_ORIGIN: '[''localhost'']'
      CMD_DB_DIALECT: ''
    restart: unless-stopped

Save this file as hedgedoc-stack.yml, then from a manager node, run docker stack deploy -c hedgedoc-stack.yml hedgedoc

version: '3.8'
services:
  hedgedoc:
    image: linuxserver/hedgedoc:latest
    ports:
      - 3000:3000/tcp
    volumes:
      - /srv/lsio/hedgedoc/config:/config
    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'
      CMD_PROTOCOL_USESSL: 'false'
      CMD_PORT: '3000'
      CMD_ALLOW_ORIGIN: '[''localhost'']'
      CMD_DB_DIALECT: ''
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

hedgedoc-deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: hedgedoc
  labels:
    app: hedgedoc
spec:
  replicas: 1
  selector:
    matchLabels:
      app: hedgedoc
  template:
    metadata:
      labels:
        app: hedgedoc
    spec:
      containers:
        - name: hedgedoc
          image: linuxserver/hedgedoc:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
            - name: DB_HOST
              value: <hostname or ip>
            - name: DB_PORT
              value: '3306'
            - name: DB_USER
              value: hedgedoc
            - name: DB_PASS
              value: <secret password>
            - name: DB_NAME
              value: hedgedoc
            - name: CMD_DOMAIN
              value: localhost
            - name: CMD_URL_ADDPORT
              value: 'false'
            - name: CMD_PROTOCOL_USESSL
              value: 'false'
            - name: CMD_PORT
              value: '3000'
            - name: CMD_ALLOW_ORIGIN
              value: '[''localhost'']'
            - name: CMD_DB_DIALECT
              value: ''
          ports:
            - containerPort: 3000
              protocol: TCP
          volumeMounts:
            - name: hedgedoc-data-0
              mountPath: /config
      volumes:
        - name: hedgedoc-data-0
          hostPath:
            path: /srv/lsio/hedgedoc/config

hedgedoc-service.yaml

apiVersion: v1
kind: Service
metadata:
  name: hedgedoc
spec:
  type: LoadBalancer
  selector:
    app: hedgedoc
  ports:
    - name: 3000-tcp
      port: 3000
      targetPort: 3000
      protocol: TCP

Save this file as ~/.config/containers/systemd/hedgedoc.container

[Unit]
Description=Hedgedoc

[Container]
Image=linuxserver/hedgedoc:latest
ContainerName=hedgedoc
PublishPort=3000:3000/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment="DB_HOST=<hostname or ip>"
Environment=DB_PORT=3306
Environment=DB_USER=hedgedoc
Environment="DB_PASS=<secret password>"
Environment=DB_NAME=hedgedoc
Environment=CMD_DOMAIN=localhost
Environment=CMD_URL_ADDPORT=false
Environment=CMD_PROTOCOL_USESSL=false
Environment=CMD_PORT=3000
Environment=CMD_ALLOW_ORIGIN=['localhost']
Environment=CMD_DB_DIALECT=
Volume=/srv/lsio/hedgedoc/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start hedgedoc

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

linuxserver.io
Blog Discord Discourse GitHub Open Collective
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

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
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.
hedgedoc

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 DB_HOST=<hostname or ip> | Host address of mariadb database | | -e DB_PORT=3306 | Port to access mariadb database default is 3306 | | -e DB_USER=hedgedoc | Database user | | -e DB_PASS=<secret password> | Database password | | -e DB_NAME=hedgedoc | Database name | | -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=false | Set to true if using a port other than 80 or 443. | | -e CMD_PROTOCOL_USESSL=false | Set to true if accessing over https via reverse proxy. | | -e 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). | | -e CMD_ALLOW_ORIGIN=['localhost'] | Comma-separated list of allowed hostnames | | -e CMD_DB_DIALECT= | 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

Docker Mods Docker Universal 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

  • 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.

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.

Similar apps

Bookstack (container) Bookstack (container) Content ManagementDokuwiki Dokuwiki Content ManagementGrav Grav Content ManagementJoplin Joplin Content ManagementObsidian Obsidian Content ManagementPlanka (container) Planka (container) Content ManagementRaneto Raneto Content ManagementWikijs Wikijs Content Management