Add homepage documentation to docs folder
All checks were successful
Build & Push Docker Image to Gitea Registry / build-and-push (push) Successful in 16s

This commit is contained in:
Kroonk
2026-07-01 17:59:59 +02:00
parent a43717f8ce
commit cc52ab9145
5 changed files with 357 additions and 0 deletions

65
docs/Mischlabs Aendern.md Normal file
View File

@@ -0,0 +1,65 @@
# 2. Wie ändere ich Dienste, Widgets oder Einstellungen?
Die gesamte Homepage wird über YAML-Dateien konfiguriert. Du musst dafür keinen Code schreiben oder das Docker-Image neu bauen. Homepage lädt diese Dateien im laufenden Betrieb automatisch neu!
---
## 1. Dienste verwalten (services.yaml)
Hier legst du die Kacheln für deine Dienste fest.
### Beispiel für einen einfachen Dienst (Öffentlich):
```yaml
- Medien: # Dies ist die Kategorie-Überschrift
- Drive: # Name des Dienstes auf der Kachel
icon: nextcloud.png # Icon-Name (aus dem Homepage-Iconset)
href: https://drive.mischlabs.de
description: Cloud-Speicher
```
### Beispiel mit Live-Docker-Status (Nur für Admin):
```yaml
- Arbeit:
- Git:
icon: gitea.png
href: https://git.mischlabs.de
description: Code-Repositories
server: local # Verweist auf docker.yaml
container: gitea # Exakter Name des Containers auf dem NAS
```
*Tipp: Wenn du `server: local` und `container: [name]` angibst, fragt Homepage den Docker-Status ab und zeigt an, ob der Container läuft (grüner Punkt) oder beendet ist (roter Punkt).*
*Eine Liste aller unterstützten App-Icons findest du in der [Homepage Dokumentation](https://gethomepage.dev/configs/services/).*
---
## 2. Einstellungen anpassen (settings.yaml)
Hier werden grundlegende Einstellungen wie Sprache und Titel definiert:
```yaml
title: MischLabs Admin # Der Name oben links im Dashboard
theme: dark # Standard-Theme (dark oder light)
language: de # Sprache für Datumsangaben und Container-Zustände (z.B. "Wird ausgeführt")
```
---
## 3. Widgets verwalten (widgets.yaml)
Widgets werden ganz oben auf der Seite als schmale Infoleisten oder Suchboxen angezeigt.
### Beispiel für Suchleiste + Hardware-Widgets (Admin):
```yaml
- search:
provider: duckduckgo # Suchanbieter (google, duckduckgo, etc.)
focus: true # Suchbox bei Seitenaufruf fokussieren
- resources:
label: NAS Status
cpu: true
memory: true
disk:
- /host/volume1 # Überwacht Volume 1 des NAS
- /host/volume2 # Überwacht Volume 2 des NAS
```
---
* [[Mischlabs Struktur|Zurück: Struktur]] | [[Mischlabs Anleitung|Zurück zur Übersicht]] | [[Mischlabs Deployment|Weiter zu: Deployment]]