Documentação

Começa com o HomeGate

Tudo o que precisas para pôr os teus serviços domésticos online.

Primeiros Passos

  1. 1
    Cria uma conta — Regista-te em /register
  2. 2
    Instala o Tailscale — Instala o Tailscale no teu servidor doméstico
  3. 3
    Adiciona um serviço — A partir do painel, adiciona o teu serviço com a tua chave de autenticação Tailscale e o IP de destino
  4. 4
    Fica online — O teu serviço fica acessível via o teu subdomínio *.homegate.sh com SSL automático

Protocolos suportados

O HomeGate suporta três protocolos:

HTTP/HTTPS

Para serviços web como Jellyfin, Nextcloud, Immich e qualquer serviço com interface web. O tráfego é encaminhado através do Caddy com SSL automático. Recebes um nome de domínio (por ex., abc123.homegate.sh) e podes adicionar domínios personalizados.

TCP

Para serviços que usam conexões TCP diretas, como Minecraft Java Edition, Terraria ou SSH. Recebes uma string de conexão host:porta à qual qualquer pessoa pode ligar-se.

UDP

Para serviços que usam UDP, como Minecraft Bedrock, Valheim ou Factorio. Igual ao TCP mas para tráfego UDP.

O proxy TCP e UDP está disponível no plano Dedicated+.

Domínios Personalizados

Cada serviço recebe um subdomínio *.homegate.sh gratuito. Para usar o teu próprio domínio, cria um registo CNAME:

# Example: point your domain to your HomeGate subdomain

jellyfin.example.com   CNAME   abc123.homegate.sh

Os certificados SSL são aprovisionados automaticamente assim que o CNAME é verificado. Normalmente demora menos de um minuto.

Domínios raiz: Registos CNAME não podem ser definidos em domínios raiz (por ex., example.com). Usa um subdomínio como stream.example.com, ou usa um fornecedor de DNS que suporte registos ALIAS/ANAME (Cloudflare, Route53).

Guias de servidores de jogos

Guias rápidos para servidores de jogos populares. Cada jogo segue o mesmo processo de configuração.

  1. 1 Certifica-te de que o servidor do jogo está a correr na tua máquina na porta predefinida
  2. 2 Instala o Tailscale na mesma máquina
  3. 3 Na dashboard do HomeGate, cria um novo serviço com o protocolo e porta de destino corretos
  4. 4 Partilha a string de conexão com os teus jogadores

Minecraft Java Edition

Protocolo: TCP Porta predefinida: 25565

Minecraft Bedrock Edition

Protocolo: UDP Porta predefinida: 19132

Valheim

Protocolo: UDP Porta predefinida: 2456

Terraria

Protocolo: TCP Porta predefinida: 7777

Factorio

Protocolo: UDP Porta predefinida: 34197

Palworld

Protocolo: UDP Porta predefinida: 8211

Referência da API

O HomeGate disponibiliza uma REST API para acesso programático a todas as funcionalidades.

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

Proteção de Acesso

Lista de IPs Permitidos

Restringe o acesso ao teu serviço por endereço IP ou intervalo CIDR. Apenas pedidos de IPs permitidos chegam ao teu serviço.

Autenticação por Cabeçalho

Exige um cabeçalho personalizado (por ex., X-Auth-Token: my-secret) para todos os pedidos. Útil para serviços que suportam autenticação por cabeçalho como o Immich ou o Jellyfin.

Serviços Suportados

Serviços web (HTTP)

O HomeGate funciona com qualquer serviço baseado em HTTP. Alguns exemplos populares:

Jellyfin :8096
Immich :2283
Plex :32400
Nextcloud :443
OpenClaw :3080
Ollama :11434
Vaultwarden :8080
Home Assistant :8123
Gitea :3000
Grafana :3000
Qualquer serviço baseado em HTTP

Servidores de jogos (TCP/UDP)

Disponível no plano Dedicated+:

Minecraft Java Edition TCP :25565
Minecraft Bedrock Edition UDP :19132
Valheim UDP :2456
Terraria TCP :7777
Factorio UDP :34197
Palworld UDP :8211
Qualquer serviço TCP ou UDP