Images

linuxserver/hedgedoc

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry 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.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling ghcr.io/linuxserver/hedgedoc 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

Tag

x86-64

amd64-latest

arm64

arm64v8-latest

armhf

arm32v7-latest

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)

Full list of HedgeDoc options

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.

version: "3"
services:
mariadb:
image: ghcr.io/linuxserver/mariadb:latest
container_name: hedgedoc_mariadb
restart: always
volumes:
- path/to/mariadb/data:/config
environment:
- MYSQL_ROOT_PASSWORD=<secret password>
- MYSQL_DATABASE=hedgedoc
- MYSQL_USER=hedgedoc
- MYSQL_PASSWORD=<secret password>
- PGID=1000
- PUID=1000
- TZ=Europe/London
hedgedoc:
image: ghcr.io/linuxserver/hedgedoc:latest
container_name: hedgedoc
restart: always
depends_on:
- mariadb
volumes:
- /path/to/config:/config
environment:
- DB_HOST=mariadb
- DB_USER=hedgedoc
- DB_PASS=<secret password>
- DB_NAME=hedgedoc
- DB_PORT=3306
- PGID=1000
- PUID=1000
- TZ=Europe/London
ports:
- "3000:3000"

docker run -d \
--name=hedgedoc \
-e PUID=1000 \
-e PGID=1000 \
-e DB_HOST=<hostname or ip> \
-e DB_PORT=3306 \
-e DB_USER=hedgedoc \
-e DB_PASS=<secret password> \
-e DB_NAME=hedgedoc \
-e TZ=Europe/London \
-p 3000:3000 \
-v /path/to/appdata:/config \
--restart unless-stopped \
ghcr.io/linuxserver/hedgedoc

Parameters

Docker images 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.

Ports (-p)

Parameter

Function

3000

If you wish to access this container from http://{IP}:${PORT}` this must be left unchanged.

Environment Variables (-e)

Env

Function

PUID=1000

for UserID - see below for explanation

PGID=1000

for GroupID - see below for explanation

DB_HOST=<hostname or ip>

Host address of mysql database

DB_PORT=3306

Port to access mysql database default is 3306

DB_USER=hedgedoc

Database user

DB_PASS=<secret password>

Database password

DB_NAME=hedgedoc

Database name

TZ=Europe/London

Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume

Function

/config

HedgeDoc config and configurable 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__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword 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 user as below:

$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

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:

    • docker exec -it hedgedoc /bin/bash

  • To monitor the logs of the container in realtime:

    • docker logs -f hedgedoc

  • Container version number

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

  • Image version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/hedgedoc

Versions

  • 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