Documentation

Démarrer avec HomeGate

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

Premiers pas

  1. 1
    Créer 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 clé 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

Protocoles supportés

HomeGate supporte trois protocoles :

HTTP/HTTPS

Pour les services web comme Jellyfin, Nextcloud, Immich et tout service avec une interface web. Le trafic est acheminé via Caddy avec SSL automatique. Vous obtenez un nom de domaine (ex. : abc123.homegate.sh) et pouvez ajouter des domaines personnalisés.

TCP

Pour les services qui utilisent des connexions TCP directes, comme Minecraft Java Edition, Terraria ou SSH. Vous obtenez une chaîne de connexion hôte:port à laquelle n'importe qui peut se connecter.

UDP

Pour les services qui utilisent UDP, comme Minecraft Bedrock, Valheim ou Factorio. Identique au TCP mais pour le trafic UDP.

Le proxy TCP et UDP est disponible sur le plan Dedicated+.

Domaines personnalisés

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

# Example: point your domain to your HomeGate subdomain

jellyfin.example.com   CNAME   abc123.homegate.sh

Les certificats SSL sont provisionnés automatiquement une fois le CNAME vérifié. Cela prend généralement moins d'une minute.

Domaines racine : les enregistrements CNAME ne peuvent pas être définis 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).

Guides serveurs de jeux

Guides de démarrage rapide pour les serveurs de jeux populaires. Chaque jeu suit le même processus de configuration.

  1. 1 Assurez-vous que le serveur de jeu tourne sur votre machine sur le port par défaut
  2. 2 Installez Tailscale sur la même machine
  3. 3 Dans le tableau de bord HomeGate, créez un nouveau service avec le bon protocole et port cible
  4. 4 Partagez la chaîne de connexion avec vos joueurs

Minecraft Java Edition

Protocole: TCP Port par défaut: 25565

Minecraft Bedrock Edition

Protocole: UDP Port par défaut: 19132

Valheim

Protocole: UDP Port par défaut: 2456

Terraria

Protocole: TCP Port par défaut: 7777

Factorio

Protocole: UDP Port par défaut: 34197

Palworld

Protocole: UDP Port par défaut: 8211

Référence API

HomeGate fournit une API REST pour un accès programmatique à toutes les fonctionnalités.

# 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 TCP service (Dedicated+)

POST /v1/services

{"name": "Minecraft Server", "targetPort": 25565, "protocol": "tcp"}

# TCP service response

{"id": "abc12345", "name": "Minecraft Server", "protocol": "tcp", "publicHost": "vps1.homegate.sh", "publicPort": 25565, "connectionString": "vps1.homegate.sh:25565", "status": "active"}

# 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'accès

Liste blanche IP

Restreignez l'accès à votre service par adresse IP ou plage CIDR. Seules les requêtes provenant des IP autorisées atteindront votre service.

Authentification par en-tête

Exigez un en-tête personnalisé (ex. : X-Auth-Token: my-secret) pour toutes les requêtes. Utile pour les services qui supportent l'authentification par en-tête comme Immich ou Jellyfin.

Services supportés

Services web (HTTP)

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

Jellyfin :8096
Immich :2283
Plex :32400
Nextcloud :443
OpenClaw :3080
Ollama :11434
Vaultwarden :8080
Home Assistant :8123
Gitea :3000
Grafana :3000
Tout service basé sur HTTP

Serveurs de jeux (TCP/UDP)

Disponible sur le plan Dedicated+ :

Minecraft Java Edition TCP :25565
Minecraft Bedrock Edition UDP :19132
Valheim UDP :2456
Terraria TCP :7777
Factorio UDP :34197
Palworld UDP :8211
Tout service TCP ou UDP