linuxserver/heimdall
500M+
The LinuxServer.io team brings you another container release featuring:
Find us at:
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.
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/heimdall: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 | ❌ |
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag | Available | Description |
---|---|---|
latest | ✅ | Stable Heimdall releases. |
development | ✅ | Latest commit from the github 2.x branch. |
Access the web gui at http://SERVERIP:PORT
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. Uncomment the basic auth
lines in /config/nginx/site-confs/default.conf
and restart the container.
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 flaged as 'optional', it is mandatory and a value must be provided.
---
services:
heimdall:
image: lscr.io/linuxserver/heimdall:latest
container_name: heimdall
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/heimdall/config:/config
ports:
- 80:80
- 443:443
restart: unless-stopped
docker run -d \
--name=heimdall \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 80:80 \
-p 443:443 \
-v /path/to/heimdall/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/heimdall:latest
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 80:80 | http gui |
-p 443:443 | https gui |
-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. |
-v /config | Persistent config files |
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.
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.
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)
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.
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" }}' lscr.io/linuxserver/heimdall:latest
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:
Update images:
All images:
docker-compose pull
Single image:
docker-compose pull heimdall
Update containers:
All containers:
docker-compose up -d
Single container:
docker-compose up -d heimdall
You can also remove the old dangling images:
docker image prune
Update the image:
docker pull lscr.io/linuxserver/heimdall:latest
Stop the running container:
docker stop heimdall
Delete the container:
docker rm heimdall
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:
docker image prune
[!TIP] We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
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-heimdall.git
cd docker-heimdall
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/heimdall:latest .
The ARM variants can be built on x86_64 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
.
development
tag..env
rather than copy. It now resides under /config/www
.env
to /config
.docker pull linuxserver/heimdall