mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-05-02 16:20:26 +00:00
fd2a1320e0
- #462: Mark gemini-cli provider as deprecated in providers.ts Add deprecated, deprecationReason, hasFree, freeNote, authHint, apiHint to Zod provider schema - #471: Add VM_DEPLOYMENT_GUIDE.md to DOC_SOURCE_FILES in generate-multilang.mjs Delete 29 stale PT-language copies and regenerate from EN source for all 30 locales (29 auto-translated + 1 Czech from PR #482)
401 lines
11 KiB
Markdown
401 lines
11 KiB
Markdown
# OmniRoute — Guia de implantação em VM com Cloudflare
|
||
|
||
🌐 **Languages:** 🇺🇸 [English](../../VM_DEPLOYMENT_GUIDE.md) | 🇧🇷 [Português (Brasil)](../pt-BR/VM_DEPLOYMENT_GUIDE.md) | 🇪🇸 [Español](../es/VM_DEPLOYMENT_GUIDE.md) | 🇫🇷 [Français](../fr/VM_DEPLOYMENT_GUIDE.md) | 🇮🇹 [Italiano](../it/VM_DEPLOYMENT_GUIDE.md) | 🇷🇺 [Русский](../ru/VM_DEPLOYMENT_GUIDE.md) | 🇨🇳 [中文 (简体)](../zh-CN/VM_DEPLOYMENT_GUIDE.md) | 🇩🇪 [Deutsch](../de/VM_DEPLOYMENT_GUIDE.md) | 🇮🇳 [हिन्दी](../in/VM_DEPLOYMENT_GUIDE.md) | 🇹🇭 [ไทย](../th/VM_DEPLOYMENT_GUIDE.md) | 🇺🇦 [Українська](../uk-UA/VM_DEPLOYMENT_GUIDE.md) | 🇸🇦 [العربية](../ar/VM_DEPLOYMENT_GUIDE.md) | 🇯🇵 [日本語](../ja/VM_DEPLOYMENT_GUIDE.md) | 🇻🇳 [Tiếng Việt](../vi/VM_DEPLOYMENT_GUIDE.md) | 🇧🇬 [Български](../bg/VM_DEPLOYMENT_GUIDE.md) | 🇩🇰 [Dansk](../da/VM_DEPLOYMENT_GUIDE.md) | 🇫🇮 [Suomi](../fi/VM_DEPLOYMENT_GUIDE.md) | 🇮🇱 [עברית](../he/VM_DEPLOYMENT_GUIDE.md) | 🇭🇺 [Magyar](../hu/VM_DEPLOYMENT_GUIDE.md) | 🇮🇩 [Bahasa Indonesia](../id/VM_DEPLOYMENT_GUIDE.md) | 🇰🇷 [한국어](../ko/VM_DEPLOYMENT_GUIDE.md) | 🇲🇾 [Bahasa Melayu](../ms/VM_DEPLOYMENT_GUIDE.md) | 🇳🇱 [Nederlands](../nl/VM_DEPLOYMENT_GUIDE.md) | 🇳🇴 [Norsk](../no/VM_DEPLOYMENT_GUIDE.md) | 🇵🇹 [Português (Portugal)](../pt/VM_DEPLOYMENT_GUIDE.md) | 🇷🇴 [Română](../ro/VM_DEPLOYMENT_GUIDE.md) | 🇵🇱 [Polski](../pl/VM_DEPLOYMENT_GUIDE.md) | 🇸🇰 [Slovenčina](../sk/VM_DEPLOYMENT_GUIDE.md) | 🇸🇪 [Svenska](../sv/VM_DEPLOYMENT_GUIDE.md) | 🇵🇭 [Filipino](../phi/VM_DEPLOYMENT_GUIDE.md) | 🇨🇿 [Čeština](../cs/VM_DEPLOYMENT_GUIDE.md)
|
||
|
||
Guia completo para instalar e configurar OmniRoute em uma VM (VPS) com domínio gerenciado via Cloudflare.
|
||
|
||
---
|
||
|
||
## Pré-requisitos
|
||
|
||
| Artigo | Mínimo | Recomendado |
|
||
| ----------- | ------------------------ | --------------- |
|
||
| **CPU** | 1 vCPU | 2 vCPUs |
|
||
| **RAM** | 1 GB | 2 GB |
|
||
| **Disco** | SSD de 10 GB | SSD de 25 GB |
|
||
| **SO** | Ubuntu 22.04LTS | Ubuntu 24.04LTS |
|
||
| **Domínio** | Registrado na Cloudflare | — |
|
||
| **Docker** | Motor Docker 24+ | Docker 27+ |
|
||
|
||
**Provedores testados**: Akamai (Linode), DigitalOcean, Vultr, Hetzner, AWS Lightsail.
|
||
|
||
---
|
||
|
||
## 1. Configure a VM
|
||
|
||
### 1.1 Crie a instância
|
||
|
||
No seu provedor VPS preferido:
|
||
|
||
- Escolha Ubuntu 24.04 LTS
|
||
- Selecione o plano mínimo (1 vCPU / 1 GB RAM)
|
||
- Defina uma senha root forte ou configure a chave SSH
|
||
- Observe o **IP público** (por exemplo, `203.0.113.10`)
|
||
|
||
### 1.2 Conectar via SSH
|
||
|
||
```bash
|
||
ssh root@203.0.113.10
|
||
```
|
||
|
||
### 1.3 Atualizar o sistema
|
||
|
||
```bash
|
||
apt update && apt upgrade -y
|
||
```
|
||
|
||
### 1.4 Instalar o Docker
|
||
|
||
```bash
|
||
# Install dependencies
|
||
apt install -y ca-certificates curl gnupg
|
||
|
||
# Add official Docker repository
|
||
install -m 0755 -d /etc/apt/keyrings
|
||
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg
|
||
chmod a+r /etc/apt/keyrings/docker.gpg
|
||
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $ (. /etc/os-release && echo “$VERSION_CODENAME”) stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
|
||
apt update
|
||
apt install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
|
||
```
|
||
|
||
### 1.5 Instale o nginx
|
||
|
||
```bash
|
||
apt install -y nginx
|
||
```
|
||
|
||
### 1.6 Configurar Firewall (UFW)
|
||
|
||
```bash
|
||
ufw default deny incoming
|
||
ufw default allow outgoing
|
||
ufw allow 22/tcp # SSH
|
||
ufw allow 80/tcp # HTTP (redirect)
|
||
ufw allow 443/tcp # HTTPS
|
||
ufw enable
|
||
```
|
||
|
||
> **Dica**: para segurança máxima, restrinja as portas 80 e 443 apenas aos IPs da Cloudflare. Consulte a seção [Advanced Security](#advanced-security).
|
||
|
||
---
|
||
|
||
## 2. Instale o OmniRoute
|
||
|
||
### 2.1 Criar diretório de configuração
|
||
|
||
```bash
|
||
mkdir -p /opt/omniroute
|
||
```
|
||
|
||
### 2.2 Criar arquivo de variáveis de ambiente
|
||
|
||
```bash
|
||
cat > /opt/omniroute/.env << ‘EOF’
|
||
# === Security ===
|
||
JWT_SECRET=CHANGE-TO-A-UNIQUE-64-CHAR-SECRET-KEY
|
||
INITIAL_PASSWORD=YourSecurePassword123!
|
||
API_KEY_SECRET=REPLACE-WITH-ANOTHER-SECRET-KEY
|
||
STORAGE_ENCRYPTION_KEY=REPLACE-WITH-THIRD-SECRET-KEY
|
||
STORAGE_ENCRYPTION_KEY_VERSION=v1
|
||
MACHINE_ID_SALT=CHANGE-TO-A-UNIQUE-SALT
|
||
|
||
# === App ===
|
||
PORT=20128
|
||
NODE_ENV=production
|
||
HOSTNAME=0.0.0.0
|
||
DATA_DIR=/app/data
|
||
STORAGE_DRIVER=sqlite
|
||
ENABLE_REQUEST_LOGS=true
|
||
AUTH_COOKIE_SECURE=false
|
||
REQUIRE_API_KEY=false
|
||
|
||
# === Domain (change to your domain) ===
|
||
BASE_URL=https://llms.seudominio.com
|
||
NEXT_PUBLIC_BASE_URL=https://llms.seudominio.com
|
||
|
||
# === Cloud Sync (optional) ===
|
||
# CLOUD_URL=https://cloud.omniroute.online
|
||
# NEXT_PUBLIC_CLOUD_URL=https://cloud.omniroute.online
|
||
EOF
|
||
```
|
||
|
||
> ⚠️ **IMPORTANTE**: Gere chaves secretas exclusivas! Use `openssl rand -hex 32` para cada chave.
|
||
|
||
### 2.3 Inicie o contêiner
|
||
|
||
```bash
|
||
docker pull diegosouzapw/omniroute:latest
|
||
|
||
docker run -d \
|
||
--name omniroute \
|
||
--restart unless-stopped \
|
||
--env-file /opt/omniroute/.env \
|
||
-p 20128:20128 \
|
||
-v omniroute-data:/app/data \
|
||
diegosouzapw/omniroute:latest
|
||
```
|
||
|
||
### 2.4 Verifique se está em execução
|
||
|
||
```bash
|
||
docker ps | grep omniroute
|
||
docker logs omniroute --tail 20
|
||
```
|
||
|
||
Deve exibir: `[DB] SQLite database ready` e `listening on port 20128`.
|
||
|
||
---
|
||
|
||
## 3. Configurar nginx (proxy reverso)
|
||
|
||
### 3.1 Gerar certificado SSL (Origem Cloudflare)
|
||
|
||
No painel da Cloudflare:
|
||
|
||
1. Vá para **SSL/TLS → Servidor de Origem**
|
||
2. Clique em **Criar certificado**
|
||
3. Mantenha os padrões (15 anos, \*.seudominio.com)
|
||
4. Copie o **Certificado de Origem** e a **Chave Privada**
|
||
|
||
```bash
|
||
mkdir -p /etc/nginx/ssl
|
||
|
||
# Paste the certificate
|
||
nano /etc/nginx/ssl/origin.crt
|
||
|
||
# Paste the private key
|
||
nano /etc/nginx/ssl/origin.key
|
||
|
||
chmod 600 /etc/nginx/ssl/origin.key
|
||
```
|
||
|
||
### 3.2 Configuração Nginx
|
||
|
||
```bash
|
||
cat > /etc/nginx/sites-available/omniroute << ‘NGINX’
|
||
# Default server — blocks direct access via IP
|
||
server {
|
||
listen 80 default_server;
|
||
listen [::]:80 default_server;
|
||
listen 443 ssl default_server;
|
||
listen [::]:443 ssl default_server;
|
||
ssl_certificate /etc/nginx/ssl/origin.crt;
|
||
ssl_certificate_key /etc/nginx/ssl/origin.key;
|
||
server_name _;
|
||
return 444;
|
||
}
|
||
|
||
# OmniRoute — HTTPS
|
||
server {
|
||
listen 443 ssl;
|
||
listen [::]:443 ssl;
|
||
server_name llms.yourdomain.com; # Change to your domain
|
||
|
||
ssl_certificate /etc/nginx/ssl/origin.crt;
|
||
ssl_certificate_key /etc/nginx/ssl/origin.key;
|
||
ssl_protocols TLSv1.2 TLSv1.3;
|
||
|
||
client_max_body_size 100M;
|
||
|
||
location / {
|
||
proxy_pass http://127.0.0.1:20128;
|
||
proxy_set_header Host $host;
|
||
proxy_set_header X-Real-IP $remote_addr;
|
||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
proxy_set_header X-Forwarded-Proto $scheme;
|
||
|
||
# WebSocket support
|
||
proxy_http_version 1.1;
|
||
proxy_set_header Upgrade $http_upgrade;
|
||
proxy_set_header Connection “upgrade”;
|
||
|
||
# SSE (Server-Sent Events) — streaming AI responses
|
||
proxy_buffering off;
|
||
proxy_cache off;
|
||
proxy_read_timeout 300s;
|
||
proxy_send_timeout 300s;
|
||
}
|
||
}
|
||
|
||
# HTTP → HTTPS redirect
|
||
server {
|
||
listen 80;
|
||
listen [::]:80;
|
||
server_name llms.yourdomain.com;
|
||
return 301 https://$server_name$request_uri;
|
||
}
|
||
NGINX
|
||
```
|
||
|
||
### 3.3 Habilitar e testar
|
||
|
||
```bash
|
||
# Remove default configuration
|
||
rm -f /etc/nginx/sites-enabled/default
|
||
|
||
# Enable OmniRoute
|
||
ln -sf /etc/nginx/sites-available/omniroute /etc/nginx/sites-enabled/omniroute
|
||
|
||
# Test and reload
|
||
nginx -t && systemctl reload nginx
|
||
```
|
||
|
||
---
|
||
|
||
## 4. Configurar DNS da Cloudflare
|
||
|
||
### 4.1 Adicionar registro DNS
|
||
|
||
No painel Cloudflare → DNS:
|
||
|
||
| Tipo | Nome | Conteúdo | Procuração |
|
||
| ---- | ------ | ------------------------- | ------------ |
|
||
| Um | `llms` | `203.0.113.10` (IP da VM) | ✅ Procurado |
|
||
|
||
### 4.2 Configurar SSL
|
||
|
||
Em **SSL/TLS → Visão geral**:
|
||
|
||
- Modo: **Completo (estrito)**
|
||
|
||
Em **SSL/TLS → Certificados Edge**:
|
||
|
||
- Sempre use HTTPS: ✅ Ligado
|
||
- Versão mínima do TLS: TLS 1.2
|
||
- Reescritas automáticas de HTTPS: ✅ Ativado
|
||
|
||
### 4.3 Teste
|
||
|
||
```bash
|
||
curl -sI https://llms.seudominio.com/health
|
||
# Should return HTTP/2 200
|
||
```
|
||
|
||
---
|
||
|
||
## 5. Operações e Manutenção
|
||
|
||
### Atualize para uma nova versão
|
||
|
||
```bash
|
||
docker pull diegosouzapw/omniroute:latest
|
||
docker stop omniroute && docker rm omniroute
|
||
docker run -d --name omniroute --restart unless-stopped \
|
||
--env-file /opt/omniroute/.env \
|
||
-p 20128:20128 \
|
||
-v omniroute-data:/app/data \
|
||
diegosouzapw/omniroute:latest
|
||
```
|
||
|
||
### Ver registros
|
||
|
||
```bash
|
||
docker logs -f omniroute # Real-time stream
|
||
docker logs omniroute --tail 50 # Last 50 lines
|
||
```
|
||
|
||
### Backup manual do banco de dados
|
||
|
||
```bash
|
||
# Copy data from the volume to the host
|
||
docker cp omniroute:/app/data ./backup-$(date +%F)
|
||
|
||
# Or compress the entire volume
|
||
docker run --rm -v omniroute-data:/data -v $(pwd):/backup \
|
||
alpine tar czf /backup/omniroute-data-$(date +%F).tar.gz /data
|
||
```
|
||
|
||
### Restaurar do backup
|
||
|
||
```bash
|
||
docker stop omniroute
|
||
docker run --rm -v omniroute-data:/data -v $(pwd):/backup \
|
||
alpine sh -c “rm -rf /data/* && tar xzf /backup/omniroute-data-YYYY-MM-DD.tar.gz -C /”
|
||
docker start omniroute
|
||
```
|
||
|
||
---
|
||
|
||
## 6. Segurança Avançada
|
||
|
||
### Restringir o nginx aos IPs da Cloudflare
|
||
|
||
```bash
|
||
cat > /etc/nginx/cloudflare-ips.conf << ‘CF’
|
||
# Cloudflare IPv4 ranges — update periodically
|
||
# https://www.cloudflare.com/ips-v4/
|
||
set_real_ip_from 173.245.48.0/20;
|
||
set_real_ip_from 103.21.244.0/22;
|
||
set_real_ip_from 103.22.200.0/22;
|
||
set_real_ip_from 103.31.4.0/22;
|
||
set_real_ip_from 141.101.64.0/18;
|
||
set_real_ip_from 108.162.192.0/18;
|
||
set_real_ip_from 190.93.240.0/20;
|
||
set_real_ip_from 188.114.96.0/20;
|
||
set_real_ip_from 197.234.240.0/22;
|
||
set_real_ip_from 198.41.128.0/17;
|
||
set_real_ip_from 162.158.0.0/15;
|
||
set_real_ip_from 104.16.0.0/13;
|
||
set_real_ip_from 104.24.0.0/14;
|
||
set_real_ip_from 172.64.0.0/13;
|
||
set_real_ip_from 131.0.72.0/22;
|
||
real_ip_header CF-Connecting-IP;
|
||
CF
|
||
```
|
||
|
||
Adicione o seguinte a `nginx.conf` dentro do bloco `http {}`:
|
||
|
||
```nginx
|
||
include /etc/nginx/cloudflare-ips.conf;
|
||
```
|
||
|
||
### Instale o fail2ban
|
||
|
||
```bash
|
||
apt install -y fail2ban
|
||
systemctl enable fail2ban
|
||
systemctl start fail2ban
|
||
|
||
# Check status
|
||
fail2ban-client status sshd
|
||
```
|
||
|
||
### Bloqueie o acesso direto à porta Docker
|
||
|
||
```bash
|
||
# Prevent direct external access to port 20128
|
||
iptables -I DOCKER-USER -p tcp --dport 20128 -j DROP
|
||
iptables -I DOCKER-USER -i lo -p tcp --dport 20128 -j ACCEPT
|
||
|
||
# Persist the rules
|
||
apt install -y iptables-persistent
|
||
netfilter-persistent save
|
||
```
|
||
|
||
---
|
||
|
||
## 7. Implantar em Cloudflare Workers (opcional)
|
||
|
||
Para acesso remoto via Cloudflare Workers (sem expor a VM diretamente):
|
||
|
||
```bash
|
||
# In the local repository
|
||
cd omnirouteCloud
|
||
npm install
|
||
npx wrangler login
|
||
npx wrangler deploy
|
||
```
|
||
|
||
Veja a documentação completa em [omnirouteCloud/README.md](../omnirouteCloud/README.md).
|
||
|
||
---
|
||
|
||
## Resumo da porta
|
||
|
||
| Porto | Serviço | Acesso |
|
||
| ----- | ----------- | ---------------------------- |
|
||
| 22 | SSH | Público (com fail2ban) |
|
||
| 80 | HTTP nginx | Redirecionar → HTTPS |
|
||
| 443 | HTTPS nginx | Através do proxy Cloudflare |
|
||
| 20128 | OmniRoute | Apenas localhost (via nginx) |
|