Skip to main content

Homepage

services:
    homepage:
        image: ghcr.io/gethomepage/homepage:latest
        container_name: homepage
        ports:
            - 5005:3000
        volumes:
            - /srv/path/to/config:/app/config
            - /srv/path1:/data # for widget resources
            - /srv/path2:/backup # for widget resources
            - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations
        environment:
            - LOG_LEVEL=debug
            - HOMEPAGE_ALLOWED_HOSTS=*
        restart: unless-stopped

HOMEPAGE_ALLOWED_HOSTS

As of v1.0 there is one required environment variable to access homepage via a URL other than localhost, HOMEPAGE_ALLOWED_HOSTS. The setting helps prevent certain kinds of attacks when retrieving data from the homepage API proxy.

The value is a comma-separated (no spaces) list of allowed hosts (sometimes with the port) that can host your homepage install. See the docker, kubernetes and source installation pages for more information about where / how to set the variable.

localhost:3000 and 127.0.0.1:3000 are always included, but you can add a domain or IP address to this list to allow that host such as HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev,192.168.1.2:1234, etc.

If you are seeing errors about host validation, check the homepage logs and ensure that the host exactly as output in the logs is in the HOMEPAGE_ALLOWED_HOSTS list.

This can be disabled by setting HOMEPAGE_ALLOWED_HOSTS to * but this is not recommended.