Self-host Homepage with Docker Compose

Fast, config-driven start page for all your self-hosted services.

This is still a work in progress.

The generated compose file and instructions may not be complete or correct for every app yet. Please report any issues you encounter to contact@bitflake.com.

The steps below take a few minutes end to end.

Docker compose setup and file
save the generated compose and env files.
Start Homepage with Docker Compose
bring the stack up and check it's healthy.

Requirements

You'll need these installed on the machine you're deploying to:

Docker

Packages Homepage and everything it depends on into an isolated container, so it runs the same way on your machine as it does everywhere else.

Install guide

Docker Compose

Reads docker-compose.ymland starts everything in it together. Ships with Docker Desktop. On Linux servers it's usually a separate install.

Install guide

1. Docker compose setup and file

Create a folder for Homepage and save the file below into it as docker-compose.yml. It describes every container the stack needs — Homepageitself and any supporting services, such as its database — along with the ports, volumes and environment variables each one uses. You'll also need an empty .env file in the same folder; Docker Compose reads it automatically and uses it to fill in the ${VARIABLE}references you'll see in the file below.

docker-compose.yml

version: "3.9"
services:
  homepage:
    image: ghcr.io/gethomepage/homepage:latest
    restart: unless-stopped
    ports:
      - 3000:3000
    environment:
      HOMEPAGE_ALLOWED_HOSTS: localhost
    volumes:
      - config:/app/config
    configs:
      - source: homepage-settings.yaml
        target: /app/config/settings.yaml
      - source: homepage-services.yaml
        target: /app/config/services.yaml
    healthcheck:
      test:
        - CMD
        - curl
        - -f
        - http://localhost:3000/
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  config: null
configs:
  homepage-services.yaml:
    content: |
      - Infrastructure:
          - Grafana:
              icon: mdi-chart-line
              href: https://grafana.com
              description: Metrics dashboards and alerting
          - Nextcloud:
              icon: mdi-cloud-outline
              href: https://nextcloud.com
              description: Self-hosted file storage and sync
          - Portainer:
              icon: mdi-docker
              href: https://www.portainer.io
              description: Container management UI

      - Productivity:
          - Vikunja:
              icon: mdi-checkbox-marked-outline
              href: https://vikunja.io
              description: Task management and to-do lists
          - Firefly III:
              icon: mdi-cash-multiple
              href: https://www.firefly-iii.org
              description: Personal finance manager
          - Joplin Server:
              icon: mdi-notebook-outline
              href: https://joplinapp.org
              description: Synced notes and documents
  homepage-settings.yaml:
    content: |
      title: Bitflake Homepage
      description: Your self-hosted services, all in one place.
      theme: dark
      color: slate
      headerStyle: boxed
      layout:
        Infrastructure:
          style: row
          columns: 3
        Productivity:
          style: row
          columns: 3

Volumes

Homepage stores its data in named Docker volumes, so it survives container restarts and updates:

config mounted at /app/config: Homepage seeds skeleton configs and writes logs under /app/config.

2. Start Homepage with Docker Compose

From the folder with docker-compose.yml and .env, run:

Terminal

Start Homepage and all its supporting services in the background.

docker compose up -d

The -d flag runs the stack in the background so it keeps running after you close the terminal. Docker will pull the images the first time, which can take a minute or two.

To check on it afterwards: docker compose ps shows whether containers are healthy, and docker compose logs -f follows their logs if something looks wrong. Once it's running, open http://localhost:3000 in your browser.