diff --git a/docs/assets/custom.css b/docs/assets/custom.css deleted file mode 100644 index f959128e..00000000 --- a/docs/assets/custom.css +++ /dev/null @@ -1,3 +0,0 @@ -.md-typeset[data-page-id="landing"] .md-header-anchor { - display: none; -} diff --git a/docs/installation/index.md b/docs/installation/index.md index 3aaa4144..f082845b 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -13,26 +13,28 @@ You have a few options for deploying homepage, depending on your needs. We offer
-:simple-docker: [  Install on Docker :octicons-arrow-right-24:](docker.md) +[:simple-docker:   Install on Docker :octicons-arrow-right-24:](docker.md) { .card } -:simple-kubernetes: [  Install on Kubernetes :octicons-arrow-right-24:](k8s.md) +[:simple-kubernetes:   Install on Kubernetes :octicons-arrow-right-24:](k8s.md) { .card } -:simple-unraid: [  Install on UNRAID :octicons-arrow-right-24:](unraid.md) +[:simple-unraid:   Install on UNRAID :octicons-arrow-right-24:](unraid.md) { .card } -:simple-nextdotjs: [  Building from source :octicons-arrow-right-24:](source.md) +[:simple-nextdotjs:   Building from source :octicons-arrow-right-24:](source.md) { .card }
### `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. This is a comma separated (no spaces) list of allowed hosts (sometimes with the port) that can host your homepage install. See the [docker](docker.md) and [source](source.md) installation pages for more information. +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. -`localhost:3000` and `127.0.0.1:3000` are always allowed, 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. +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](docker.md), [kubernetes](k8s.md) and [source](source.md) installation pages for more information about where / how to set the variable. -If you are seeing errors about host validation, check the homepage logs and ensure that the host as listed in the logs is in the `HOMEPAGE_ALLOWED_HOSTS` list. +`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. diff --git a/docs/installation/source.md b/docs/installation/source.md index 6697eb92..fd0275a7 100644 --- a/docs/installation/source.md +++ b/docs/installation/source.md @@ -9,7 +9,13 @@ First, clone the repository: git clone https://github.com/gethomepage/homepage.git ``` -Then install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like): +If `pnpm` is not installed, install it: + +```bash +npm install -g pnpm +``` + +Then install dependencies and build the production bundle: ```bash pnpm install diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index eb1ddd25..7f299d2e 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -286,3 +286,13 @@ body[data-md-color-scheme="default"] { .md-tabs__link { transform: translateZ(0); } + +.grid.cards .card { + padding: 0; +} + +.grid.cards .card a { + display: block; + padding: 0.8rem; + text-decoration: none; +} diff --git a/package.json b/package.json index 83e80a38..ae9047c1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "homepage", - "version": "1.0.3", + "version": "1.1.0", "private": true, "scripts": { "preinstall": "npx only-allow pnpm",