OmniRoute — Deployment Guide on VM with Cloudflare (Español)

Requisitos previos

Elemento	Mínimo	Recomendado
CPU	1 vCPU	2 vCPU
RAM	1 GB	2 GB
Disco	10 GB SSD	25 GB SSD
SO	Ubuntu 22.04 LTS	Ubuntu 24.04 LTS
Dominio	Registrado en Cloudflare	—
Docker	Docker Engine 24+	Docker 27+

Proveedores probados: Akamai (Linode), DigitalOcean, Vultr, Hetzner, AWS Lightsail.

---

1. Configurar la máquina virtual

1.1 Crear la instancia

En su proveedor de VPS preferido:

• Elija Ubuntu 24.04 LTS
• Seleccione el plan mínimo (1 vCPU / 1 GB RAM)
• Establezca una contraseña segura para root o configure una clave SSH
• Anote la IP pública (p. ej., 203.0.113.10)

1.2 Conectarse mediante SSH

ssh root@203.0.113.10

1.3 Actualizar el sistema

apt update && apt upgrade -y

1.4 Instalar Docker

# Instalar dependencias
apt install -y ca-certificates curl gnupg

# Añadir el repositorio oficial de Docker
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 Instalar nginx

apt install -y nginx

1.6 Configurar el firewall (UFW)

ufw default deny incoming
ufw default allow outgoing
ufw allow 22/tcp    # SSH
ufw allow 80/tcp    # HTTP (redirección)
ufw allow 443/tcp   # HTTPS
ufw enable

Consejo: Para obtener la máxima seguridad, restrinja los puertos 80 y 443 únicamente a las IP de Cloudflare. Consulte la sección Seguridad avanzada.

---

2. Instalar OmniRoute

2.1 Crear el directorio de configuración

mkdir -p /opt/omniroute

2.2 Crear el archivo de variables de entorno

cat > /opt/omniroute/.env << 'EOF'
# === Seguridad ===
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
OMNIROUTE_WS_BRIDGE_SECRET=REPLACE-WITH-WS-BRIDGE-SECRET  # OBLIGATORIO en producción: utilizado por el puente WS de Codex Responses

# === Aplicación ===
PORT=20128
NODE_ENV=production
HOSTNAME=0.0.0.0
DATA_DIR=/app/data
APP_LOG_TO_FILE=true
AUTH_COOKIE_SECURE=true
REQUIRE_API_KEY=false

# === URL (cámbielas por su dominio) ===
# URL base interna de servidor a servidor para tareas programadas y solicitudes internas.
BASE_URL=http://127.0.0.1:20128
# URL orientada al navegador utilizada para devoluciones de llamada de OAuth, enlaces del panel y URL públicas generadas.
NEXT_PUBLIC_BASE_URL=https://llms.seudominio.com
# Sustitución explícita opcional del origen público para las URL de recursos públicos generadas.
# OMNIROUTE_PUBLIC_BASE_URL=https://llms.seudominio.com

# === Sincronización en la nube (opcional) ===
# CLOUD_URL=https://cloud.omniroute.online
# NEXT_PUBLIC_CLOUD_URL=https://cloud.omniroute.online
EOF

⚠️ IMPORTANTE: ¡Genere claves secretas únicas! Utilice openssl rand -hex 32 para cada clave.

2.3 Iniciar el contenedor

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 Verificar que esté en ejecución

docker ps | grep omniroute
docker logs omniroute --tail 20

Debería mostrar: [DB] SQLite database ready y listening on port 20128.

---

3. Configurar nginx (proxy inverso)

3.1 Generar el certificado SSL (origen de Cloudflare)

En el panel de Cloudflare:

1. Ve a SSL/TLS → Servidor de origen
2. Haz clic en Crear certificado
3. Mantén los valores predeterminados (15 años, *.yourdomain.com)
4. Copia el Certificado de origen y la Clave privada

mkdir -p /etc/nginx/ssl

# Pega el certificado
nano /etc/nginx/ssl/origin.crt

# Pega la clave privada
nano /etc/nginx/ssl/origin.key

chmod 600 /etc/nginx/ssl/origin.key

3.2 Configuración de Nginx

cat > /etc/nginx/sites-available/omniroute << 'NGINX'
# Servidor predeterminado — bloquea el acceso directo mediante 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;  # Cámbialo por tu dominio

    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-Forwarded-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;

        # Compatibilidad con WebSocket
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        # SSE (eventos enviados por el servidor) — respuestas de IA en streaming
        proxy_buffering off;
        proxy_cache off;
        proxy_read_timeout 600s;
        proxy_send_timeout 600s;
    }
}

# Redirección de HTTP → HTTPS
server {
    listen 80;
    listen [::]:80;
    server_name llms.yourdomain.com;
    return 301 https://$server_name$request_uri;
}
NGINX

Mantén los tiempos de espera del flujo del proxy inverso alineados con las variables de entorno de tiempo de espera de OmniRoute. Si aumentas FETCH_TIMEOUT_MS / STREAM_IDLE_TIMEOUT_MS, aumenta proxy_read_timeout / proxy_send_timeout por encima del mismo umbral.

OmniRoute usa NEXT_PUBLIC_BASE_URL como el origen canónico visible para el navegador para las devoluciones de llamada de OAuth y los enlaces públicos generados. Las escrituras autenticadas del panel usan solicitudes del mismo origen junto con protección CSRF vinculada a la sesión, por lo que no requieren una URL base pública estática. Los encabezados X-Forwarded-* anteriores siguen siendo metadatos de enrutamiento útiles, pero no sustituyen la configuración de la URL pública explícita cuando OAuth o los enlaces generados para el navegador la necesitan. Habilita OMNIROUTE_TRUST_PROXY únicamente si los clientes no pueden acceder directamente a OmniRoute y tu proxy elimina/reconstruye los encabezados reenviados entrantes.

3.3 Habilitar y probar

# Elimina la configuración predeterminada
rm -f /etc/nginx/sites-enabled/default

# Habilita OmniRoute
ln -sf /etc/nginx/sites-available/omniroute /etc/nginx/sites-enabled/omniroute

# Prueba y recarga
nginx -t && systemctl reload nginx

---

4. Configurar el DNS de Cloudflare

4.1 Añadir un registro DNS

En el panel de Cloudflare → DNS:

Tipo	Nombre	Contenido	Proxy
A	llms	203.0.113.10 (IP de la VM)	✅ Con proxy

4.2 Configurar SSL

En SSL/TLS → Información general:

• Modo: Completo (estricto)

En SSL/TLS → Certificados perimetrales:

• Usar siempre HTTPS: ✅ Activado
• Versión mínima de TLS: TLS 1.2
• Reescrituras HTTPS automáticas: ✅ Activadas

4.3 Pruebas

curl -sI https://llms.seudominio.com/health
# Debe devolver HTTP/2 200

---

5. Operaciones y mantenimiento

Actualizar a una nueva versión

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 los registros

docker logs -f omniroute          # Flujo en tiempo real
docker logs omniroute --tail 50   # Últimas 50 líneas

Copia de seguridad manual de la base de datos

# Copiar los datos del volumen al host
docker cp omniroute:/app/data ./backup-$(date +%F)

# O comprimir el volumen completo
docker run --rm -v omniroute-data:/data -v $(pwd):/backup \
  alpine tar czf /backup/omniroute-data-$(date +%F).tar.gz /data

Restaurar desde una copia de seguridad

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. Seguridad avanzada

Restringir nginx a las IP de Cloudflare

cat > /etc/nginx/cloudflare-ips.conf << 'CF'
# Rangos IPv4 de Cloudflare — actualizar periódicamente
# 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

Añada lo siguiente a nginx.conf dentro del bloque http {}:

include /etc/nginx/cloudflare-ips.conf;

Instalar fail2ban

apt install -y fail2ban
systemctl enable fail2ban
systemctl start fail2ban

# Comprobar el estado
fail2ban-client status sshd

Bloquear el acceso directo al puerto de Docker

# Impedir el acceso externo directo al puerto 20128
iptables -I DOCKER-USER -p tcp --dport 20128 -j DROP
iptables -I DOCKER-USER -i lo -p tcp --dport 20128 -j ACCEPT

# Hacer persistentes las reglas
apt install -y iptables-persistent
netfilter-persistent save

---

7. Desplegar en Cloudflare Workers (opcional)

Para acceder de forma remota mediante Cloudflare Workers (sin exponer directamente la VM):

# En el repositorio local
cd omnirouteCloud
npm install
npx wrangler login
npx wrangler deploy

Consulte también TUNNELS_GUIDE.md para ver la guía paso a paso de Cloudflare Tunnel incluida en el repositorio. El worker independiente omnirouteCloud/ se encuentra en un repositorio complementario separado.

---

Resumen de puertos

Puerto	Servicio	Acceso
22	SSH	Público (con fail2ban)
80	nginx HTTP	Redirección → HTTPS
443	nginx HTTPS	Mediante el proxy de Cloudflare
20128	OmniRoute	Solo localhost (mediante nginx)

Optimización para poca memoria / VPS pequeños

Para implementaciones en instancias VPS pequeñas (1 GB de RAM o menos):

• Deshabilite los servicios en segundo plano — establezca OMNIROUTE_DISABLE_BACKGROUND_SERVICES=1 para omitir el programador, el servidor MCP y las tareas periódicas de mantenimiento. Consulte docs/reference/ENVIRONMENT.md.
• Use el modo WAL de SQLite — está habilitado de forma predeterminada y reduce el uso máximo de memoria durante las lecturas simultáneas.
• Limite el heap de V8 — establezca OMNIROUTE_MEMORY_MB (p. ej., 512) para que el entorno de ejecución no calcule un límite superior al de la máquina virtual. Consulte docs/reference/ENVIRONMENT.md.
• La admisión de cargas pesadas se ajusta automáticamente según el límite del heap – una vez establecido OMNIROUTE_MEMORY_MB como se indica arriba, el presupuesto de bytes de entrada (OMNIROUTE_CHAT_MAX_INFLIGHT_BYTES) se deriva de ese mismo límite, por lo que una máquina virtual con memoria limitada obtiene automáticamente un presupuesto menor de solicitudes simultáneas sin ajustes adicionales; las solicitudes excedentes reciben un 503 reintentable con Retry-After, en lugar de competir por la memoria. Establezca el límite heredado por número de solicitudes OMNIROUTE_CHAT_MAX_HEAVY_IN_FLIGHT solo si necesita un límite estricto adicional.
• Evite ejecutar next build en el VPS — compile localmente e implemente la salida independiente (.next/standalone/).
• Supervise con top / free -m — OmniRoute suele utilizar entre 200 y 400 MB de RSS en reposo en una máquina virtual de 1 GB.

---

Código fuente de OmniRoute (a58000c7685f)