Skip to content

Homepage

docker-compose.yaml
services:
homepage:
image: ghcr.io/gethomepage/homepage:latest
container_name: homepage
environment:
PUID: ${HOMEPAGE_PUID}
PGID: ${HOMEPAGE_PGID}
HOMEPAGE_ALLOWED_HOSTS: ${HOMEPAGE_ALLOWED_HOSTS} # comma separated list of allowed hosts
ports:
- 3000:3000
volumes:
- /opt/containers/homepage:/app/config
- /var/run/docker.sock:/var/run/docker.sock:ro # optional, for docker integrations
restart: unless-stopped

You can configure Homepage by editing the files in the /opt/containers/homepage directory. The main configuration files are:

  • bookmarks.yaml: Contains your favorite links.
  • custom.css: Custom CSS for styling your homepage.
  • custom.js: Custom JavaScript for additional functionality.
  • docker.yaml: Configuration for Docker integration.
  • kubernetes.yaml: Configuration for Kubernetes integration.
  • services.yaml: Configuration for the services you want to display on your homepage.
  • settings.yaml: General settings for the homepage.
  • widgets.yaml: Configuration for the widgets you want to display on your homepage. You can also view the logs of the homepage service in the logs directory.
  • Directoryopt
    • Directorycontainers
      • Directoryhomepage
        • bookmarks.yaml
        • custom.css
        • custom.js
        • docker.yaml
        • kubernetes.yaml
        • Directorylogs/
          • homepage.log
        • services.yaml
        • settings.yaml
        • widgets.yaml


References