Homepage with Docker Compose

What Homepage needs

Only figures Homepage's own documentation publishes, each linked to the page it is on. Where the project gives no number, this page does not invent one.

On top of this, Caddy (the reverse proxy in the file) is a single small container.

Which hardware Homepage has images for

Read from each image's manifest list in its registry (anonymous, read-only) when this page was built. An app counts for a CPU only if every one of its images lists it.

• x86-64 PC or NAS (linux/amd64): every image has a build.
• Raspberry Pi 4/5, 64-bit OS (linux/arm64): every image has a build.
• Raspberry Pi 3 or Zero 2 W, 32-bit OS (linux/arm/v7): no image for homepage. No image for this hardware; the builder leaves the app out.

A manifest says an image exists for a CPU, not how well Homepage runs on it: a build for arm64 or arm/v7 can still be too slow or need more memory than the board has. The RAM and disk Homepage publishes are in the table above and, for a whole set of apps against a Raspberry Pi, on Will it run on my machine?. A tag like latest can move to a new digest after the date checked.

docker-compose.yml

This is exactly what the builder writes for Homepage alone on example.org: the official definition with its published ports removed and Caddy added in front. Every ${VARIABLE} is defined in the .env below.

# docker-compose.yml built at dankhost.com for: Homepage
# Each app block is its official compose definition. Only the names were prefixed with
# the app slug (services, containers, volumes, bind folders, .env variables) so any set of
# apps can share one file; other differences are listed under "Changed:" in each block.
# Only Caddy publishes ports. Secrets live in .env next to this file.

services:
  # ---- Caddy: the one reverse proxy, HTTPS certificates from Let's Encrypt ----
  # Source: https://caddyserver.com/docs/running (checked 2026-09-23)
  # Source: https://github.com/dani-garcia/vaultwarden/wiki/Using-Docker-Compose (checked 2026-09-23)
  # Caddyfile goes in ./caddy/Caddyfile. Fixed address 172.30.0.2 so apps can trust it exactly.
  caddy:
    image: "caddy:2"
    container_name: "caddy"
    restart: "unless-stopped"
    ports:
      - "80:80"
      - "443:443"
      - "443:443/udp"
    volumes:
      - "./caddy:/etc/caddy"
      - "caddy-data:/data"
      - "caddy-config:/config"
    networks:
      proxy:
        ipv4_address: "172.30.0.2"

  # ---- Homepage (dash.example.org) ----
  # Source: https://gethomepage.dev/installation/docker/ (checked 2026-09-26)
  # Source: https://gethomepage.dev/installation/ (checked 2026-09-26)
  # Changed: Removed the '3000:3000' port; Caddy reaches homepage:3000 on the proxy network. /path/to/config becomes ./config.
  #          HOMEPAGE_ALLOWED_HOSTS, which the docs mark required, is your hostname.
  #          Left out the optional /var/run/docker.sock mount ("(optional) For docker integrations"): the Docker page says using the socket directly is not the recommended method of integration, and without it Homepage cannot reach Docker at all.
  #          Added the password gate from the Security & Authentication section, because the page says public deployments of Homepage should be secured: HOMEPAGE_AUTH_ENABLED=true, a generated HOMEPAGE_AUTH_SECRET (the page asks for at least 32 characters; this one has 48), HOMEPAGE_EXTERNAL_URL as your https address and a generated HOMEPAGE_AUTH_PASSWORD.
  homepage:
    image: "ghcr.io/gethomepage/homepage:latest"
    container_name: "homepage"
    volumes:
      - "./homepage/config:/app/config"
    environment:
      HOMEPAGE_ALLOWED_HOSTS: "dash.example.org"
      HOMEPAGE_AUTH_ENABLED: "true"
      HOMEPAGE_AUTH_SECRET: "${HOMEPAGE_AUTH_SECRET}"
      HOMEPAGE_EXTERNAL_URL: "https://dash.example.org"
      HOMEPAGE_AUTH_PASSWORD: "${HOMEPAGE_AUTH_PASSWORD}"
    networks:
      proxy: {}

networks:
  # Pinned so the trusted-proxy address given to each app (172.30.0.2) is exact.
  # If "docker compose up" reports "Pool overlaps", change 172.30.0 here, in Caddy's
  # ipv4_address and in every trusted-proxy value to a free 172.x.0 range.
  proxy:
    ipam:
      config:
        - subnet: "172.30.0.0/24"
          ip_range: "172.30.0.128/25"
          gateway: "172.30.0.1"

volumes:
  caddy-data:
  caddy-config:

Caddyfile save as caddy/Caddyfile

Caddy gets and renews the HTTPS certificate for dash.example.org by itself once the DNS record points at your server and ports 80 and 443 reach it.

# Caddyfile built at dankhost.com. Save it as ./caddy/Caddyfile next to docker-compose.yml.
# Caddy gets and renews a Let's Encrypt certificate for each name below by itself,
# once the DNS records point at this server and ports 80 and 443 reach it.

# Homepage
dash.example.org {
	reverse_proxy homepage:3000
}

.env

The secrets are left blank here on purpose: a password printed on a public page is the same for everyone who copies it. The builder fills them with random letters and digits made in your browser.

# .env for Homepage, from dankhost.com/app/homepage/. Fill the blank secrets before starting.
# Keep this file private (chmod 600).

# Homepage
# 48 random letters and digits: the builder fills this in your browser
HOMEPAGE_AUTH_SECRET=
# 24 random letters and digits: the builder fills this in your browser
HOMEPAGE_AUTH_PASSWORD=

Changes from the official file

Besides prefixing every service, container, volume, folder and variable with homepage (so any set of apps can share one file), these are all the differences from what the project documents:

• Removed the '3000:3000' port; Caddy reaches homepage:3000 on the proxy network. /path/to/config becomes ./config.
• HOMEPAGE_ALLOWED_HOSTS, which the docs mark required, is your hostname.
• Left out the optional /var/run/docker.sock mount ("(optional) For docker integrations"): the Docker page says using the socket directly is not the recommended method of integration, and without it Homepage cannot reach Docker at all.
• Added the password gate from the Security & Authentication section, because the page says public deployments of Homepage should be secured: HOMEPAGE_AUTH_ENABLED=true, a generated HOMEPAGE_AUTH_SECRET (the page asks for at least 32 characters; this one has 48), HOMEPAGE_EXTERNAL_URL as your https address and a generated HOMEPAGE_AUTH_PASSWORD.

Notes for Homepage behind the proxy

• Log in at https://dash.example.org with HOMEPAGE_AUTH_PASSWORD from .env.
• The installation page says Homepage does not rate-limit password attempts and logs each failure as "Failed password sign-in attempt"; it suggests rate limiting at the proxy, which this file does not add.
• Homepage is set up by editing the YAML files in ./homepage/config.
• The documented file sets no restart policy, so Homepage does not come back by itself after a reboot. Run 'docker compose up -d' again, or add restart: unless-stopped.

Back it up

Homepage keeps nothing but its configuration: the YAML files in /app/config, which is ./config here.

Below is the BACKUP.md the builder writes next to the compose file above: which of its folders and volumes hold data, what to copy with which container stopped, and a restore check. Pick more apps in the builder and it covers them all in one file.

# BACKUP.md built at dankhost.com for: Homepage

What to copy from the docker-compose.yml built with this file, the database dump each project documents (rewritten for the service names in that file), what to copy with which container stopped, and how to check the result. Run every command in the folder that holds docker-compose.yml.

The folders are owned by the containers' users: put sudo in front of tar if it says "Permission denied". Named volumes live under /var/lib/docker/volumes, not next to the compose file, so they are copied through a throwaway ubuntu container (Docker's documented --volumes-from method). tar makes a full copy each run; for large folders an incremental tool (restic, borg, rsync) saves time and space.

Never run "docker compose down -v" on this file: it deletes the named volumes of every app in it.

## Before you start

    BACKUP=/mnt/backup/selfhost   # change this: a disk or machine other than this server's system disk
    mkdir -p "$BACKUP"

## Every time: the three stack files

    tar czf "$BACKUP/stack-files.tar.gz" docker-compose.yml .env caddy

.env holds the database passwords and secret keys the apps were set up with; keep this archive as private as the data.

## Caddy (the reverse proxy)

Caddy's docs: 'The data directory must not be treated as a cache.' It holds the TLS certificates and their private keys; without it Caddy has to ask Let's Encrypt for every certificate again.

- caddy-data (named volume, /data in caddy)
  BACK UP: TLS certificates, private keys, OCSP staples.
- caddy-config (named volume, /config in caddy)
  SKIP: the last active configuration, kept for 'caddy run --resume', which this setup does not use: it starts from the Caddyfile.
- ./caddy (/etc/caddy in caddy)
  IN stack-files.tar.gz: the Caddyfile, copied with the stack files above.

Copy (Caddy keeps serving while you copy):

    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu tar cvf /backup/caddy-data.tar /data

Restore check:

    tar tf "$BACKUP/caddy-data.tar" > /dev/null && echo OK
    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu bash -c "cd /data && tar xvf /backup/caddy-data.tar --strip 1"

Sources:
- Caddy docs: Conventions, Data directory: https://caddyserver.com/docs/conventions#data-directory (checked 2026-09-24)
- Docker docs: Volumes, Back up, restore, or migrate data volumes: https://docs.docker.com/engine/storage/volumes/#back-up-restore-or-migrate-data-volumes (checked 2026-09-24)

## Homepage

Homepage keeps nothing but its configuration: the YAML files in /app/config, which is ./config here.

What this compose mounts:
- ./homepage/config (/app/config in homepage)
  BACK UP: the YAML files that make up your dashboard (services, bookmarks, widgets, settings).

1. Stop homepage. Stopping it means no file is half-written while you copy.

    docker compose stop homepage

2. Copy while homepage is stopped:

    tar czf "$BACKUP/homepage-config.tar.gz" ./homepage/config

3. Start it again:

    docker compose start homepage

Restore check:

    tar tzf "$BACKUP/homepage-config.tar.gz" > /dev/null && echo OK

Put a copy back (with homepage stopped):

    tar xzf "$BACKUP/homepage-config.tar.gz"   # recreates ./homepage/config; move the old folder aside first

Stop it, put ./homepage/config back, start it.

Sources:
- Homepage docs: Docker installation (compose example, /app/config, optional Docker socket): https://gethomepage.dev/installation/docker/ (checked 2026-09-26)
- Docker docs: Volumes, Back up, restore, or migrate data volumes: https://docs.docker.com/engine/storage/volumes/#back-up-restore-or-migrate-data-volumes (checked 2026-09-26)

Sources

Every page below was fetched on the date shown.

• Homepage README on GitHub checked 2026-09-26 (what it does)
• Homepage docs: Docker installation (compose example, /app/config, optional Docker socket) checked 2026-09-26 (compose definition and proxy settings, backup plan)
• Homepage docs: Installation (HOMEPAGE_ALLOWED_HOSTS, Security & Authentication) checked 2026-09-26 (compose definition and proxy settings)
• Caddy docs: Keep Caddy running (Docker Compose section) checked 2026-09-23 (Caddy)
• Vaultwarden wiki: Caddy with HTTP challenge (uses the caddy:2 image) checked 2026-09-23 (Caddy)
• Docker docs: Volumes, Back up, restore, or migrate data volumes checked 2026-09-26 (backup plan)
• Caddy docs: Conventions, Data directory checked 2026-09-24 (backup plan)

Add Homepage to the builder All forty apps