Documentation

Demarrer avec HomeGate

Tout ce dont vous avez besoin pour mettre vos services en ligne.

Premiers pas

  1. 1
    Creer un compte — Inscrivez-vous sur /register
  2. 2
    Installer Tailscale — Installez Tailscale sur votre serveur domestique
  3. 3
    Ajouter un service — Depuis le tableau de bord, ajoutez votre service avec votre cle d'authentification Tailscale et l'IP cible
  4. 4
    Mise en ligne — Votre service est accessible via votre sous-domaine *.homegate.sh avec SSL automatique

Domaines personnalises

Chaque service obtient un sous-domaine *.homegate.sh gratuit. Pour utiliser votre propre domaine, creez un enregistrement CNAME :

# Example: point your domain to your HomeGate subdomain

jellyfin.example.com   CNAME   abc123.homegate.sh

Les certificats SSL sont provisonnes automatiquement une fois le CNAME verifie. Cela prend generalement moins d'une minute.

Domaines racine : les enregistrements CNAME ne peuvent pas etre definis sur les domaines racine (ex. : example.com). Utilisez un sous-domaine comme stream.example.com, ou un fournisseur DNS qui supporte les enregistrements ALIAS/ANAME (Cloudflare, Route53).

Reference API

HomeGate fournit une API REST pour un acces programmatique a toutes les fonctionnalites.

# 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"}

Protection d'acces

Liste blanche IP

Restreignez l'acces a votre service par adresse IP ou plage CIDR. Seules les requetes provenant des IP autorisees atteindront votre service.

Authentification par en-tete

Exigez un en-tete personnalise (ex. : X-Auth-Token: my-secret) pour toutes les requetes. Utile pour les services qui supportent l'authentification par en-tete comme Immich ou Jellyfin.

Services supportes

HomeGate fonctionne avec n'importe quel service base sur HTTP. Quelques exemples populaires :

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