From bc73ad8b5d3da26540b2ad3e2819e88527218e8e Mon Sep 17 00:00:00 2001 From: CJ Date: Sun, 18 Jan 2026 12:02:54 +0000 Subject: [PATCH] Upload files to "Homepage" --- Homepage/README.md | 168 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 168 insertions(+) create mode 100644 Homepage/README.md diff --git a/Homepage/README.md b/Homepage/README.md new file mode 100644 index 0000000..55730b5 --- /dev/null +++ b/Homepage/README.md @@ -0,0 +1,168 @@ +# Homepage + +Some basic customisations for Homepage, a custom homelab dashboard. Check out the [official Wiki](https://gethomepage.dev/) for further customisation and [service widgits](https://gethomepage.dev/en/configs/service-widgets/). + +### Add custom icons + +If you add new images to `/portainer/Files/AppData/Config/Homepage/icons` make sure to restart the container. + +## Docker + +Set up the Docker connectionby editing `docker.yaml`, for local a local connection set up like the below, for a remote connection remove the hashes before `rpi-remote.lan`, `host`, `port` and add hashes before `rpi-full.lan` and `socket`: + +``` +sudo nano /portainer/Files/AppData/Config/Homepage/docker.yaml +``` +``` +--- +# For configuration options and examples, please see: +# https://gethomepage.dev/en/configs/docker/ + +# rpi-remote.lan: +# host: 192.168.1.227 +# port: 9000 + +rpi-local.lan: + socket: /var/run/docker.sock +``` + +## Settings + +Set the title, fave icon, background, theme, header style, link target, language, and layout: +``` +sudo nano /portainer/Files/AppData/Config/Homepage/settings.yaml +``` +``` +--- +# For configuration options and examples, please see: +# https://gethomepage.dev/en/configs/settings + +title: HOMEPAGE TITLE + +favicon: URL OR LOCAL LINK TO .ICO + +background: URL OR LOCAL LINK TO IMAGE +backgroundOpacity: 0.3 + +theme: dark + +headerStyle: boxed + +target: _blank + +providers: + openweathermap: SUPER SECRET API KEY + +language: en-GB + +layout: + CATEGORY NAME: + icon: URL, LOCAL LINK TO IMAGE, OR DASHBOARD ICONS REFERENCE + style: column + columns: 1 + CATEGORY NAME 2: + icon: URL, LOCAL LINK TO IMAGE, OR DASHBOARD ICONS REFERENCE + style: column + columns: 1 +``` + +## Widgets + +Set top row of the page, setting `expanded` to `true` will show the load, RAM, and storage totals as well as the current usage: +``` +sudo nano /portainer/Files/AppData/Config/Homepage/widgets.yaml +``` +``` +--- +# For configuration options and examples, please see: +# https://gethomepage.dev/en/configs/widgets + +- greeting: + text_size: 2x1 + text: GREETING MESSAGE + +- resources: + cpu: true + memory: true + expanded: true + disk: / + +- search: + provider: google + target: _blank + +- datetime: + text_size: xl + format: + dateStyle: short + timeStyle: short + hour12: false + +- openweathermap: + latitude: LAT + longitude: LONG + units: metric # or imperial + apiKey: API KEY + cache: 5 # Time in minutes to cache API responses, to stay within limits + +``` + +## Services + +Set main body links, update the server to `rpi-remote.lan` if you are using a remote connection: +``` +sudo nano /portainer/Files/AppData/Config/Homepage/services.yaml +``` +``` +--- +# For configuration options and examples, please see: +# https://gethomepage.dev/en/configs/services + +- CATEGORY NAME: + - SERVICE NAME: + icon: URL, LOCAL LINK TO IMAGE, OR DASHBOARD ICONS REFERENCE + description: DESCRIPTION + server: rpi-full.lan # The docker server that was configured + container: CONTAINER NAME IN DOCKER + - SERVICE NAME 2: + icon: URL, LOCAL LINK TO IMAGE, OR DASHBOARD ICONS REFERENCE + description: DESCRIPTION + server: rpi-full.lan # The docker server that was configured + container: CONTAINER NAME IN DOCKER + +- CATEGORY NAME 2: + - SERVICE NAME 3: + icon: URL, LOCAL LINK TO IMAGE, OR DASHBOARD ICONS REFERENCE + description: DESCRIPTION + server: rpi-full.lan # The docker server that was configured + container: CONTAINER NAME IN DOCKER +``` + +## Bookmarks + +Set bookmark links: +``` +sudo nano /portainer/Files/AppData/Config/Homepage/bookmarks.yaml +``` +``` +--- +# For configuration options and examples, please see: +# https://gethomepage.dev/en/configs/bookmarks + +- CATEGORY: + - SITE NAME: + - icon: URL, LOCAL LINK TO IMAGE, OR DASHBOARD ICONS REFERENCE + href: URL TO SITE + - SITE NAME 2: + - icon: URL, LOCAL LINK TO IMAGE, OR DASHBOARD ICONS REFERENCE + href: URL TO SITE + +- CATEGORY 2: + - SITE NAME 3: + - icon: URL, LOCAL LINK TO IMAGE, OR DASHBOARD ICONS REFERENCE + href: URL TO SITE + - SITE NAME 4: + - icon: URL, LOCAL LINK TO IMAGE, OR DASHBOARD ICONS REFERENCE + href: URL TO SITE + +```