Skip to content

Heimdall Heimdall Heimdall

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
Heimdall Host Port
Heimdall /config Path

Build Status Last Commit

An Application dashboard and launcher — organize all your web apps and services in one place.
Port 80
Registry ghcr.io/daemonless/heimdall
Daemonless daemonless/heimdall
Source linuxserver/Heimdall
Website heimdall.site

Version Tags

Multi-arch manifests — resolve automatically to the right image for your platform.

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.
Tag Description Best For
latest-amd64 Upstream Binary. Built from official release. Most users — recommended.
Tag Description Best For
latest-aarch64 Upstream Binary. Built from official release. Most users — recommended.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
services:
  heimdall:
    image: "ghcr.io/daemonless/heimdall:latest"
    container_name: heimdall
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - APP_URL=  # Full URL where Heimdall is accessed (e.g. http://heimdall.lan)
    volumes:
      - "/path/to/containers/heimdall:/config"
    ports:
      - "80:80"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

1
2
3
4
5
6
7
8
podman run -d --name heimdall \
  -p 80:80 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e APP_URL= \
  -v /path/to/containers/heimdall:/config \
  ghcr.io/daemonless/heimdall:latest

Save as run.sh, then run sh run.sh.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
- name: Deploy heimdall
  containers.podman.podman_container:
    name: heimdall
    image: "ghcr.io/daemonless/heimdall:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
      APP_URL: ""
    ports:
      - "80:80"
    volumes:
      - "/path/to/containers/heimdall:/config"

Save as heimdall-deploy.yaml, then run ansible-playbook heimdall-deploy.yaml.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
7
# .env

DIRECTOR_PROJECT=heimdall
PUID=1000
PGID=1000
TZ=UTC
APP_URL=

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  heimdall:
    name: heimdall
    options:
      - container: 'args:--pull'
      - expose: '80:80 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - APP_URL: !ENV '${APP_URL}'
    volumes:
      - HEIMDALL_CONFIG_PATH: /config
volumes:
  HEIMDALL_CONFIG_PATH:
    device: '/path/to/containers/heimdall'

1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/heimdall:${tag}

Save the files above, then run appjail-director up.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="80:80 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e APP_URL= \
  -o fstab="/path/to/containers/heimdall /config <pseudofs>" \
  ghcr.io/daemonless/heimdall:latest heimdall

Save the files above, then run sh run.sh.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
services:
  heimdall:
    name: heimdall
    image: "ghcr.io/daemonless/heimdall:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - APP_URL=
    volumes:
      - "/path/to/containers/heimdall:/config"

Save as bastille-compose.yml, then run bastille up.

1
2
3
4
5
6
7
bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --env APP_URL= \
  --volume /path/to/containers/heimdall /config \
  heimdall ghcr.io/daemonless/heimdall:latest inherit

Access at: http://localhost:80

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
APP_URL `` Full URL where Heimdall is accessed (e.g. http://heimdall.lan)

Volumes

Path Description
/config Configuration directory (database, .env, storage)

Ports

Port Protocol Description
80 TCP Web UI

Implementation Details

  • Architectures: amd64, aarch64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.