Do banco à API,
sem atrito.

ANTES DE COMEÇAR

O que você precisa

INSTALAÇÃO

Execute a imagem Docker

O fluxo recomendado usa um arquivo .env e um volume Docker persistente. A tag latest acompanha a versão mais recente publicada.

Invoke-WebRequest -Uri https://raw.githubusercontent.com/atentor/RestGo/main/.env.example -OutFile .env
notepad .env

docker volume create restgo_data
docker pull ghcr.io/atentor/restgo:latest
docker run -d --name restgo --restart unless-stopped \
  --stop-timeout 60 --env-file .env \
  -p 127.0.0.1:8080:8080 \
  -v restgo_data:/var/lib/restgo \
  ghcr.io/atentor/restgo:latest

docker logs -f restgo
Invoke-WebRequest -Uri http://localhost:8080/health `
  -Headers @{ Authorization = "SEU_RESTGO_AUTHORIZATION" }
docker inspect --format='{{.State.Health.Status}}' restgo

PERSISTÊNCIA

Volumes: seus dados ficam fora do container

O volume Docker restgo_data é a fonte de verdade da instalação. Ele mantém o PostgreSQL administrativo, os arquivos do Storage e os backups criados pelo painel, mesmo quando o container é atualizado ou recriado.

docker volume ls
docker volume inspect restgo_data

CONFIGURAÇÃO

Conecte à sua operação

RESTGO_PORT=8080
RESTGO_BASE_URL=https://api.seudominio.com
RESTGO_TIMEZONE=America/Sao_Paulo

AUTH_SMTP_HOST=smtp.exemplo.com
AUTH_SMTP_PORT=587
AUTH_SMTP_TLS=starttls
AUTH_SMTP_USERNAME=...

POSTGRESQL EXTERNO

Gere e instale certificados TLS

A exposição do PostgreSQL para terceiros é desabilitada por padrão. Ao configurá-la, mantenha TLS ativo: o RestGo entrega aos clientes o modo verify-full, que valida a criptografia e o nome DNS do servidor.

$postgresHost = 'postgres.seudominio.com'
$tlsDirectory = 'C:\RestGo\tls'

New-Item -ItemType Directory -Force -Path $tlsDirectory

openssl req -x509 -newkey rsa:4096 -sha256 -nodes `
  -keyout "$tlsDirectory\server.key" `
  -out "$tlsDirectory\server.crt" `
  -days 365 `
  -subj "/CN=$postgresHost" `
  -addext "subjectAltName=DNS:$postgresHost"

RESTGO_POSTGRES_EXTERNAL_CIDRS=203.0.113.10/32
RESTGO_POSTGRES_EXTERNAL_HOST=postgres.seudominio.com
RESTGO_POSTGRES_EXTERNAL_PORT=5432
RESTGO_POSTGRES_ALLOW_INSECURE_EXTERNAL=false

RESTGO_POSTGRES_TLS_CERT_SOURCE=C:/RestGo/tls/server.crt
RESTGO_POSTGRES_TLS_KEY_SOURCE=C:/RestGo/tls/server.key

docker compose up --build

RESTGO_POSTGRES_TLS_CERT_FILE=/tls/server.crt
RESTGO_POSTGRES_TLS_KEY_FILE=/tls/server.key

docker run ... --env-file .env `
  -p 0.0.0.0:5432:5432 `
  -v C:\RestGo\tls:/tls:ro `
  -v restgo_data:/var/lib/restgo `
  ghcr.io/atentor/restgo:latest

PRIMEIRA ROTA

Publique dados em quatro movimentos

No painel, os bancos representam destinos PostgreSQL; os endpoints são scripts SQL nomeados. O vínculo entre eles publica a rota.

1. Cadastre um bancoEm Databases, informe host, porta, nome, slug e descrição do PostgreSQL de destino.
2. Crie um endpointEm Endpoints, escreva o script SQL. Parâmetros usam o formato :nome.
3. Vincule e escolha a versãoEm Links, associe banco e endpoint. O RestGo publica uma rota como /v1/{slug_banco}/{slug_endpoint}.
4. Faça a chamadaEnvie parâmetros pela query string ou corpo JSON. Em conflitos, os valores do body prevalecem.

REQUEST{
  "cliente_id": 42,
  "valor": 189.90
}

RESPONSE{
  "success": true,
  "error": null,
  "data": { "id": 918 }
}

OPERAÇÃO

Feito para permanecer previsível

REFERÊNCIA

Variáveis de ambiente

Copie o conteúdo abaixo para criar seu .env. Troque todos os valores de exemplo que sejam credenciais antes de iniciar em produção.

# Aplicação e deploy
RESTGO_PORT=8080
RESTGO_BASE_URL=http://localhost:8080
RESTGO_TIMEZONE=America/Sao_Paulo
RESTGO_APP_IMAGE=

# PostgreSQL externo para terceiros
RESTGO_POSTGRES_EXTERNAL_CIDRS=
RESTGO_POSTGRES_EXTERNAL_HOST=
RESTGO_POSTGRES_EXTERNAL_PORT=5432
RESTGO_POSTGRES_EXTERNAL_BIND_ADDRESS=0.0.0.0
RESTGO_POSTGRES_ALLOW_INSECURE_EXTERNAL=false
RESTGO_POSTGRES_TLS_CERT_FILE=
RESTGO_POSTGRES_TLS_KEY_FILE=
RESTGO_POSTGRES_TLS_CERT_SOURCE=
RESTGO_POSTGRES_TLS_KEY_SOURCE=

# Banco administrativo e bancos de destino
POSTGRES_PASSWORD=troque-esta-senha-do-banco-administrativo
RESTGO_POSTGRES_PASSWORD_RECOVERY=false
RESTGO_APP_DB_USER=restgo_app
RESTGO_APP_DB_PASSWORD=troque-esta-senha-do-usuario-da-api
RESTGO_USER_DB_EXTERNAL=restgo_dynamic
RESTGO_PASSWORD_DB_EXTERNAL=troque-esta-senha-dos-bancos-dinamicos

# Pools PostgreSQL
DATABASE_MAX_OPEN_CONNS=20
DATABASE_MAX_IDLE_CONNS=10
DATABASE_CONN_MAX_LIFETIME_MINUTES=30
DATABASE_CONN_MAX_IDLE_TIME_MINUTES=5

# Acesso e sessões
RESTGO_AUTHORIZATION=change-this-token
JWT_SECRET=change-this-with-a-random-secret-of-at-least-32-characters
JWT_ISSUER=restgo
AUTH_TOKEN_TTL_HOURS=24
AUTH_REMEMBER_TOKEN_TTL_HOURS=8760

# Senhas e autenticação
AUTH_ARGON2_TIME_COST=3
AUTH_ARGON2_MEMORY_COST=65536
AUTH_ARGON2_PARALLELISM=4
AUTH_MAX_LOGIN_ATTEMPTS=5
AUTH_LOCKOUT_MINUTES=15
AUTH_RESET_TOKEN_TTL_MINUTES=30
AUTH_RESET_REQUEST_COOLDOWN_SECONDS=60
AUTH_EMAIL_CONFIRMATION_TOKEN_TTL_MINUTES=1440

# E-mail SMTP
AUTH_SMTP_HOST=
AUTH_SMTP_PORT=587
AUTH_SMTP_USERNAME=
AUTH_SMTP_PASSWORD=
AUTH_SMTP_FROM=
AUTH_SMTP_TLS=starttls
AUTH_SMTP_TIMEOUT_SECONDS=10

# Storage, backup e auditoria
STORAGE_MAX_GIB=10
BACKUP_MAX_GIB=10
LOG_ASYNC_QUEUE_SIZE=1024
LOG_ASYNC_WORKERS=2
LOG_RETENTION_DAYS=30

Legenda das variáveis

SEGURANÇA

Checklist para produção

• Use um JWT_SECRET aleatório com pelo menos 32 caracteres e um token administrativo forte.
• Coloque o painel atrás de HTTPS e mantenha SMTP com TLS em produção.
• Não registre, publique ou versione senhas, tokens ou credenciais PostgreSQL/SMTP.
• Mantenha o volume /var/lib/restgo em armazenamento persistente.
• Use uma conta restrita para os bancos de destino e não exponha o banco administrativo.