Merge remote-tracking branch 'origin/main' into dev

.editorconfig

@@ -11,3 +11,6 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 max_line_length = 120
+
+[*.md]
+trim_trailing_whitespace = false

.github/FUNDING.yml

@@ -1,2 +1,3 @@
-github: [gethomepage, benphelps, shamoon]
+github: [gethomepage]
 open_collective: homepage
+patreon: gethomepage

.github/workflows/docs-publish.yml

@@ -2,15 +2,15 @@ name: Docs
 
 on:
  push:
- tags: [ 'v*.*.*' ]
- branches: ['main']
+ tags: ["v*.*.*"]
+ branches: ["main"]
  paths:
- - 'docs/**'
- - 'mkdocs.yml'
+ - "docs/**"
+ - "mkdocs.yml"
  pull_request:
  paths:
- - 'docs/**'
- - 'mkdocs.yml'
+ - "docs/**"
+ - "mkdocs.yml"
  merge_group:
  workflow_dispatch:
 
@@ -22,16 +22,13 @@ jobs:
  name: Linting Checks
  runs-on: ubuntu-22.04
  steps:
- -
- name: Checkout repository
+ - name: Checkout repository
  uses: actions/checkout@v4
- -
- name: Install python
+ - name: Install python
  uses: actions/setup-python@v5
  with:
  python-version: 3.x
- -
- name: Check files
+ - name: Check files
  uses: pre-commit/[email protected]
 
  test:
@@ -54,7 +51,7 @@ jobs:
  mkdocs-material-
  - run: sudo apt-get install pngquant
  - run: pip install mike
- - run: pip install mkdocs-material
+ - run: pip install mkdocs-material mkdocs-redirects "mkdocs-material[imaging]"
  - name: Test Docs Build
  run: MKINSIDERS=false mkdocs build
  deploy:
@@ -80,6 +77,7 @@ jobs:
  - run: sudo apt-get install pngquant
  - run: pip install mike==2.0.0
  - run: pip install git+https://${GH_TOKEN}@github.com/benphelps/mkdocs-material-insiders.git
+ - run: pip install mkdocs-redirects "mkdocs-material[imaging]"
  - name: Set Git config
  run: |
  git config --global user.name "GitHub Action"

README.md

@@ -66,6 +66,10 @@ Homepage is highly customizable, with support for custom themes, custom CSS & JS
 
 For configuration options, examples and more, [please check out the homepage documentation](http:https://gethomepage.dev).
 
+## Security Notice 🔒
+
+Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.
+
 ## With Docker
 
 Using docker compose:

docs/configs/index.md

@@ -1,6 +1,7 @@
 ---
 title: Configuration
 description: Homepage Configuration
+icon: material/cog
 ---
 
 Homepage uses YAML for configuration, YAML stands for "YAML Ain't Markup Language.". It's a human-readable data serialization format that's a superset of JSON. Great for config files, easy to read and write. Supports complex data types like lists and objects. **Indentation matters.** If you already use Docker Compose, you already use YAML.

docs/configs/kubernetes.md

@@ -98,6 +98,8 @@ When the Kubernetes cluster connection has been properly configured, this servic
 
 If you are using multiple instances of homepage, an `instance` annotation can be specified to limit services to a specific instance. If no instance is provided, the service will be visible on all instances.
 
+If you have a single service that needs to be shown on multiple specific instances of homepage (but not on all of them), the service can be annotated by multiple `instance.name` annotations, where `name` can be the names of your specific multiple homepage instances. For example, a service that is annotated with `gethomepage.dev/instance.public: ""` and `gethomepage.dev/instance.internal: ""` will be shown on `public` and `internal` homepage instances.
+
 ### Traefik IngressRoute support
 
 Homepage can also read ingresses defined using the Traefik IngressRoute custom resource definition. Due to the complex nature of Traefik routing rules, it is required for the `gethomepage.dev/href` annotation to be set:

docs/index.md

@@ -1,5 +1,7 @@
 ---
 title: Home
+description: A modern, fully static, fast, secure, fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages.
+icon: material/home
 hide:
  - navigation
  - toc

docs/installation/index.md

@@ -1,12 +1,17 @@
 ---
 title: Installation
 description: Docs intro
+icon: simple/docker
 ---
 
 <p>
 You have a few options for deploying homepage, depending on your needs. We offer docker images for a majority of platforms. You can also install and run homepage from source if Docker is not your thing. It can even be installed on Kubernetes with Helm.
 </p>
 
+!!! danger
+
+ Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.
+
 <br>
 
 <div class="grid cards" style="margin: 0 auto;" markdown>

docs/layouts/custom.yml

@@ -0,0 +1,252 @@
+# Copyright (c) 2016-2024 Martin Donath <[email protected]>
+
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+# -----------------------------------------------------------------------------
+# Configuration
+# -----------------------------------------------------------------------------
+
+# Definitions
+definitions:
+ # Background image
+ - &background_image >-
+ {{ layout.background_image | x }}
+
+ # Background color (default: indigo)
+ - &background_color >-
+ {%- if layout.background_color -%}
+ {{ layout.background_color }}
+ {%- else -%}
+ {%- set palette = config.theme.palette or {} -%}
+ {%- if not palette is mapping -%}
+ {%- set list = palette | selectattr("primary") | list + palette -%}
+ {%- set palette = list | first -%}
+ {%- endif -%}
+ {%- set primary = palette.get("primary", "indigo") -%}
+ {%- set primary = primary.replace(" ", "-") -%}
+ {{ {
+ "red": "#ef5552",
+ "pink": "#e92063",
+ "purple": "#ab47bd",
+ "deep-purple": "#7e56c2",
+ "indigo": "#4051b5",
+ "blue": "#2094f3",
+ "light-blue": "#02a6f2",
+ "cyan": "#00bdd6",
+ "teal": "#009485",
+ "green": "#4cae4f",
+ "light-green": "#8bc34b",
+ "lime": "#cbdc38",
+ "yellow": "#ffec3d",
+ "amber": "#ffc105",
+ "orange": "#ffa724",
+ "deep-orange": "#ff6e42",
+ "brown": "#795649",
+ "grey": "#757575",
+ "blue-grey": "#546d78",
+ "black": "#000000",
+ "white": "#ffffff"
+ }[primary] or "#4051b5" }}
+ {%- endif -%}
+
+ # Text color (default: white)
+ - &color >-
+ {%- if layout.color -%}
+ {{ layout.color }}
+ {%- else -%}
+ {%- set palette = config.theme.palette or {} -%}
+ {%- if not palette is mapping -%}
+ {%- set list = palette | selectattr("primary") | list + palette -%}
+ {%- set palette = list | first -%}
+ {%- endif -%}
+ {%- set primary = palette.get("primary", "indigo") -%}
+ {%- set primary = primary.replace(" ", "-") -%}
+ {{ {
+ "red": "#ffffff",
+ "pink": "#ffffff",
+ "purple": "#ffffff",
+ "deep-purple": "#ffffff",
+ "indigo": "#ffffff",
+ "blue": "#ffffff",
+ "light-blue": "#ffffff",
+ "cyan": "#ffffff",
+ "teal": "#ffffff",
+ "green": "#ffffff",
+ "light-green": "#ffffff",
+ "lime": "#000000",
+ "yellow": "#000000",
+ "amber": "#000000",
+ "orange": "#000000",
+ "deep-orange": "#ffffff",
+ "brown": "#ffffff",
+ "grey": "#ffffff",
+ "blue-grey": "#ffffff",
+ "black": "#ffffff",
+ "white": "#000000"
+ }[primary] or "#ffffff" }}
+ {%- endif -%}
+
+ # Font family (default: Roboto)
+ - &font_family >-
+ {%- if layout.font_family -%}
+ {{ layout.font_family }}
+ {%- elif config.theme.font is mapping -%}
+ {{ config.theme.font.get("text", "Roboto") }}
+ {%- else -%}
+ Roboto
+ {%- endif -%}
+
+ # Font variant
+ - &font_variant >-
+ {%- if layout.font_variant -%}
+ {{ layout.font_variant }}
+ {%- endif -%}
+
+ # Site name
+ - &site_name >-
+ {{ config.site_name }}
+
+ # Page title
+ - &page_title >-
+ {%- if layout.title -%}
+ {{ layout.title }}
+ {%- else -%}
+ {{ page.meta.get("title", page.title) }}
+ {%- endif -%}
+
+ # Page title with site name
+ - &page_title_with_site_name >-
+ {%- if not page.is_homepage -%}
+ {{ page.meta.get("title", page.title) }} - {{ config.site_name }}
+ {%- else -%}
+ {{ page.meta.get("title", page.title) }}
+ {%- endif -%}
+
+ # Page description
+ - &page_description >-
+ {%- if layout.description -%}
+ {{ layout.description }}
+ {%- else -%}
+ {{ page.meta.get("description", config.site_description) | x }}
+ {%- endif -%}
+
+ # Page icon
+ - &page_icon >-
+ {{ page.meta.icon | x }}
+
+ # Logo
+ - &logo >-
+ {%- if layout.logo -%}
+ {{ layout.logo }}
+ {%- elif config.theme.logo -%}
+ {{ config.docs_dir }}/{{ config.theme.logo }}
+ {%- endif -%}
+
+ # Logo (icon)
+ - &logo_icon >-
+ {%- if not layout.logo and config.theme.icon -%}
+ {{ config.theme.icon.logo | x }}
+ {%- endif -%}
+
+# Meta tags
+tags:
+ # Open Graph
+ og:type: website
+ og:title: *page_title_with_site_name
+ og:description: *page_description
+ og:image: "{{ image.url }}"
+ og:image:type: "{{ image.type }}"
+ og:image:width: "{{ image.width }}"
+ og:image:height: "{{ image.height }}"
+ og:url: "{{ page.canonical_url }}"
+
+ # Twitter
+ twitter:card: summary_large_image
+ twitter:title: *page_title_with_site_name
+ twitter:description: *page_description
+ twitter:image: "{{ image.url }}"
+
+# -----------------------------------------------------------------------------
+# Specification
+# -----------------------------------------------------------------------------
+
+# Card size and layers
+size: { width: 1200, height: 630 }
+layers:
+ # Background
+ - background:
+ image: *background_image
+ color: *background_color
+
+ # Page icon
+ - size: { width: 630, height: 630 }
+ offset: { x: 800, y: 0 }
+ icon:
+ value: *page_icon
+ color: "#FFFFFF20"
+
+ # Logo
+ - size: { width: 64, height: 64 }
+ offset: { x: 64, y: 64 }
+ background:
+ image: *logo
+ icon:
+ value: *logo_icon
+ color: *color
+
+ # Site name
+ - size: { width: 768, height: 42 }
+ offset: { x: 160, y: 74 }
+ typography:
+ content: *site_name
+ color: *color
+ font:
+ family: *font_family
+ variant: *font_variant
+ style: Bold
+
+ # Page title
+ - size: { width: 864, height: 256 }
+ offset: { x: 62, y: 192 }
+ typography:
+ content: *page_title
+ align: start
+ color: *color
+ line:
+ amount: 3
+ height: 1.25
+ font:
+ family: *font_family
+ variant: *font_variant
+ style: Bold
+
+ # Page description
+ - size: { width: 864, height: 64 }
+ offset: { x: 64, y: 512 }
+ typography:
+ content: *page_description
+ align: start
+ color: *color
+ line:
+ amount: 2
+ height: 1.5
+ font:
+ family: *font_family
+ variant: *font_variant
+ style: Regular

docs/more/index.md

@@ -1,6 +1,7 @@
 ---
 title: More
 description: More homepage resources and guides.
+icon: material/information-slab-circle
 ---
 
 Here you'll find resources and guides for Homepage, troubleshooting tips, and more.