Instalação

O ForgeRouter roda inteiramente em container — não há instalação nativa suportada, porque o próprio projeto depende de um conjunto fixo de bibliotecas Python que o Docker garante reprodutível entre ambientes.

Requisitos

• Docker Engine 24+ e Docker Compose v2.
• Uma porta livre para o serviço (padrão 2100, configurável).
• Opcional: PostgreSQL, se você quiser gerenciar provedores por um dashboard em vez do arquivo YAML estático (veja Configuração de provedores).

docker-compose.yml mínimo

services:
  forgerouter:
    image: ghcr.io/darckware/forgerouter:latest
    restart: unless-stopped
    ports:
      - "127.0.0.1:2100:2100"
    volumes:
      - ./config/providers.yaml:/app/config/providers.yaml:ro
    environment:
      - FORGEROUTER_API_KEY=troque-por-uma-chave-forte

Repare que a porta é publicada só em 127.0.0.1 — se o ForgeRouter for ficar atrás de um proxy reverso (recomendado em produção), não exponha a porta diretamente para a internet.

Variáveis de ambiente principais

Variável	Obrigatória	Descrição
FORGEROUTER_API_KEY	Sim	Chave que os seus clientes usam no header Authorization: Bearer.
FORGEROUTER_PORT	Não (padrão 2100)	Porta interna do serviço.
DATABASE_URL	Não	Se definida, o ForgeRouter usa Postgres como fonte de verdade dos provedores em vez do YAML estático.

Rodando non-root

A imagem oficial já roda como usuário não-root por padrão — não é necessário nenhum ajuste adicional no docker-compose.yml para isso.