Dokumentation

Erste Schritte mit HomeGate

Alles, was du brauchst, um deine Home-Services live zu bringen.

Erste Schritte

  1. 1
    Konto erstellen — Registriere dich auf /register
  2. 2
    Tailscale installieren — Installiere Tailscale auf deinem Homeserver
  3. 3
    Dienst hinzufügen — Füge im Dashboard deinen Dienst mit deinem Tailscale-Auth-Key und der Ziel-IP hinzu
  4. 4
    Online gehen — Dein Dienst ist über deine *.homegate.sh-Subdomain mit Auto SSL erreichbar

Eigene Domains

Jeder Dienst bekommt eine kostenlose *.homegate.sh-Subdomain. Um deine eigene Domain zu nutzen, erstelle einen CNAME-Eintrag:

# Example: point your domain to your HomeGate subdomain

jellyfin.example.com   CNAME   abc123.homegate.sh

SSL-Zertifikate werden automatisch bereitgestellt, sobald der CNAME verifiziert ist. Dauert normalerweise weniger als eine Minute.

Naked Domains: CNAME-Einträge können nicht auf Root-Domains gesetzt werden (z. B. example.com). Verwende eine Subdomain wie stream.example.com, oder nutze einen DNS-Anbieter, der ALIAS/ANAME-Einträge unterstützt (Cloudflare, Route53).

API-Referenz

HomeGate bietet eine REST API für programmatischen Zugriff auf alle Funktionen.

# Base URL

https://api.homegate.sh/v1

# Authentication

Authorization: Bearer <access_token>

# Add a service

POST /v1/services

{"name": "jellyfin", "ts_key": "tskey-auth-xxxx", "target": "100.100.1.5:8096"}

# Add a custom domain

POST /v1/services/:id/domains

{"hostname": "jellyfin.example.com"}

# Add an IP allowlist rule

POST /v1/services/:id/protection

{"type": "ip", "value": "203.0.113.0/24"}

Zugriffsschutz

IP-Allowlisting

Beschränke den Zugriff auf deinen Dienst nach IP-Adresse oder CIDR-Bereich. Nur Anfragen von erlaubten IPs erreichen deinen Dienst.

Header-Authentifizierung

Fordere einen eigenen Header (z. B. X-Auth-Token: my-secret) für alle Anfragen. Nützlich für Dienste, die Header-basierte Authentifizierung unterstützen, wie Immich oder Jellyfin.

Unterstützte Dienste

HomeGate funktioniert mit jedem HTTP-basierten Dienst. Einige beliebte Beispiele:

Jellyfin :8096
Immich :2283
Plex :32400
Nextcloud :443
Ollama :11434
Vaultwarden :8080
Home Assistant :8123
Gitea :3000
Grafana :3000