From a090f98fab057b5274eecc57de463174af3081aa Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 14 Mar 2025 11:23:52 -0700 Subject: [PATCH 1/3] Add HOMEPAGE_ALLOWED_HOSTS to readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2f1e7d9e..8d9fe74b 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,7 @@ services: image: ghcr.io/gethomepage/homepage:latest container_name: homepage environment: + HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required when deploying via public URL PUID: 1000 # optional, your user id PGID: 1000 # optional, your group id ports: @@ -94,6 +95,7 @@ or docker run: ```bash docker run --name homepage \ + -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev \ -e PUID=1000 \ -e PGID=1000 \ -p 3000:3000 \ From 91518d972d35c392742d3aa24292c819fbb1bb70 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 14 Mar 2025 12:18:57 -0700 Subject: [PATCH 2/3] Update index.md --- docs/installation/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/index.md b/docs/installation/index.md index 22712015..0037b61e 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -29,4 +29,4 @@ You have a few options for deploying homepage, depending on your needs. We offer ### `HOMEPAGE_ALLOWED_HOSTS` -As of v1.0 there is one required environment variable when deploying via a public URL, HOMEPAGE_ALLOWED_HOSTS. This is a comma separated list of allowed hosts that can access your homepage. See the [docker](docker.md) and [source](source.md) installation pages for examples. +As of v1.0 there is one required environment variable when deploying via a public URL, HOMEPAGE_ALLOWED_HOSTS. This is a comma separated list of allowed hosts (sometimes with the port) that can access your homepage. See the [docker](docker.md) and [source](source.md) installation pages for examples. From f7889eab276469be6889edb568ea1f1952653747 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 14 Mar 2025 12:31:10 -0700 Subject: [PATCH 3/3] Clarify port --- docs/installation/docker.md | 4 ++-- docs/installation/source.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/installation/docker.md b/docs/installation/docker.md index 07c38071..cbe0fa32 100644 --- a/docs/installation/docker.md +++ b/docs/installation/docker.md @@ -38,7 +38,7 @@ services: - /path/to/config:/app/config # Make sure your local config directory exists - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations, see alternative methods environment: - HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required when deploying via public URL + HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev:1234 # required when deploying via public URL PUID: $PUID PGID: $PGID ``` @@ -46,7 +46,7 @@ services: ### With Docker Run ```bash -docker run -p 3000:3000 -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/gethomepage/homepage:latest +docker run -p 3000:3000 -e HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev:1234 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/gethomepage/homepage:latest ``` ### Using Environment Secrets diff --git a/docs/installation/source.md b/docs/installation/source.md index 38fcc2c5..f0f07140 100644 --- a/docs/installation/source.md +++ b/docs/installation/source.md @@ -21,7 +21,7 @@ If this is your first time starting, copy the `src/skeleton` directory to `confi Finally, run the server: ```bash -HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev pnpm start +HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev:1234 pnpm start ``` When updating homepage versions you will need to re-build the static files i.e. repeat the process above.