Heimdall is a way to organise all those links to your most used web sites and web applications in a simple way. Simplicity is the key to Heimdall. Why not use it as your browser start page? It even has the ability to include a search bar using either Google, Bing or DuckDuckGo.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling 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:
amd64-<version tag>
arm64v8-<version tag>
arm32v7-<version tag>

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Stable Heimdall releases.
Latest commit from the github master branch.

Application Setup

Access the web gui at http://SERVERIP:PORT

Adding password protection

This image now supports password protection through htpasswd. Run the following command on your host to generate the htpasswd file docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd <username>. Replace with a username of your choice and you will be asked to enter a password. New installs will automatically pick it up and implement password protected access. Existing users updating their image can delete their site config at /config/nginx/site-confs/default and restart the container after updating the image. A new site config with htpasswd support will be created in its place.


To help you get started creating a container from this image you can either use docker-compose or the docker cli.
version: "2.1"
container_name: heimdall
- PUID=1000
- PGID=1000
- TZ=Europe/London
- </path/to/appdata/config>:/config
- 80:80
- 443:443
restart: unless-stopped
docker run -d \
--name=heimdall \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 80:80 \
-p 443:443 \
-v </path/to/appdata/config>:/config \
--restart unless-stopped \


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)

http gui
https gui

Environment Variables (-e)

for UserID - see below for explanation
for GroupID - see below for explanation
Specify a timezone to use EG Europe/London

Volume Mappings (-v)

Contains all relevant configuration files.
Miscellaneous Options

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

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 heimdall /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f heimdall
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}'


  • 13.03.21: - Make searchproviders.yaml user configurable.
  • 11.03.21: - Rebase to alpine 3.14.
  • 10.02.21: - Revert to alpine 3.12 as php 7.4 broke laravel.
  • 10.02.21: - Rebasing to alpine 3.13.
  • 17.08.20: - Add php7-curl.
  • 01.06.20: - Rebasing to alpine 3.12.
  • 17.01.20: - Use nginx from baseimage.
  • 19.12.19: - Rebasing to alpine 3.11.
  • 16.07.19: - Save laravel.log to /config/log/heimdall.
  • 28.06.19: - Rebasing to alpine 3.10.
  • 01.04.19: - Fix permission detect logic.
  • 26.03.19: - Install Heimdall during container start to prevent delayed start due to overlayfs bug with recursive chown.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 15.03.19: - Clarify docker image tags in readme.
  • 22.02.19: - Rebasing to alpine 3.9.
  • 16.01.18: - Generate random app key in .env for new installs.
  • 20.11.18: - Upgrade baseimage packages during build.
  • 04.11.18: - Add php7-zip.
  • 31.10.18: - Add queue service.
  • 17.10.18: - Symlink avatars folder.
  • 16.10.18: - Updated fastcgi_params for user login support.
  • 07.10.18: - Symlink .env rather than copy. It now resides under /config/www
  • 30.09.18: - Multi-arch image. Move .env to /config.
  • 05.09.18: - Rebase to alpine linux 3.8.
  • 06.03.18: - Use password protection if htpasswd is set. Existing users can delete their default site config at /config/nginx/site-confs/default and restart the container, a new default site config with htpasswd support will be created in its place
  • 12.02.18: - Initial Release.
Copy link
On this page
Supported Architectures
Version Tags
Application Setup
Environment variables from files (Docker secrets)
Umask for running applications
User / Group Identifiers
Docker Mods
Support Info