Setting Up Homepage with Docker Compose¶

Introduction to Homepage¶

Homepage is a customizable start page or dashboard for your browser, designed to provide quick access to your frequently used websites, services, and tools.

Docker Compose Configuration for Homepage¶

This Docker Compose setup deploys the Homepage application in a Docker container, allowing you to have a personalized start page for your browsing experience.

Docker Compose File (docker-compose.yml)¶

version: "3.3"
services:
  homepage:
    image: ghcr.io/gethomepage/homepage:latest
    container_name: homepage
    ports:
      - 3000:3000
    volumes:
      - ./config:/app/config # Make sure your local config directory exists
      - /var/run/docker.sock:/var/run/docker.sock:ro # (optional) For docker integrations

Key Components of the Configuration¶

Service: Homepage¶

• Image: ghcr.io/gethomepage/homepage:latest is the Docker image used for Homepage.
• Ports:
• 3000:3000 maps port 3000 on the host to port 3000 in the container, where the Homepage web interface is accessible.
• Volumes:
• ./config:/app/config: Maps a local configuration directory to the container's configuration directory.
• /var/run/docker.sock:/var/run/docker.sock:ro: (Optional) Allows Homepage to integrate with Docker, provided read-only.

Deploying Homepage¶

1. Ensure that the local ./config directory exists and contains your configuration files.
2. Save the Docker Compose configuration in a docker-compose.yml file.
3. Run docker compose up -d to start Homepage in detached mode.
4. Access Homepage by navigating to http://<host-ip>:3000.

Configuring and Using Homepage¶

The Homepage configuration lives in the ./config directory. Key files:

• services.yaml — define your service tiles and widget integrations
• bookmarks.yaml — add bookmark groups and links
• settings.yaml — global layout, title, and appearance settings

Full documentation is available at gethomepage.dev.

Youtube Video¶

Updating Homepage¶

docker compose pull
docker compose up -d

If there is an issue with this guide or you wish to suggest changes, please raise an issue on GitHub.