OmniRoute — Deployment Guide on VM with Cloudflare (中文 (简体))

前提条件

项目	最低配置	推荐配置
CPU	1 vCPU	2 vCPU
内存	1 GB	2 GB
磁盘	10 GB SSD	25 GB SSD
操作系统	Ubuntu 22.04 LTS	Ubuntu 24.04 LTS
域名	已在 Cloudflare 注册	—
Docker	Docker Engine 24+	Docker 27+

已测试的服务商：Akamai (Linode)、DigitalOcean、Vultr、Hetzner、AWS Lightsail。

---

1. 配置虚拟机

1.1 创建实例

在您首选的 VPS 服务商处：

• 选择 Ubuntu 24.04 LTS
• 选择最低配置套餐（1 vCPU / 1 GB 内存）
• 设置高强度的 root 密码或配置 SSH 密钥
• 记下公网 IP（例如 203.0.113.10）

1.2 通过 SSH 连接

ssh root@203.0.113.10

1.3 更新系统

apt update && apt upgrade -y

1.4 安装 Docker

# 安装依赖项
apt install -y ca-certificates curl gnupg

# 添加 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 安装 nginx

apt install -y nginx

1.6 配置防火墙（UFW）

ufw default deny incoming
ufw default allow outgoing
ufw allow 22/tcp    # SSH
ufw allow 80/tcp    # HTTP（重定向）
ufw allow 443/tcp   # HTTPS
ufw enable

提示：为获得最高安全性，请将端口 80 和 443 限制为仅允许 Cloudflare IP 访问。请参阅高级安全部分。

---

2. 安装 OmniRoute

2.1 创建配置目录

mkdir -p /opt/omniroute

2.2 创建环境变量文件

cat > /opt/omniroute/.env << 'EOF'
# === 安全 ===
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  # 生产环境中必需：由 Codex Responses WS bridge 使用

# === 应用 ===
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（请更改为您的域名）===
# 用于计划任务/自请求的内部服务器间基础 URL。
BASE_URL=http://127.0.0.1:20128
# 用于 OAuth 回调、仪表板链接和生成的公共 URL 的浏览器端 URL。
NEXT_PUBLIC_BASE_URL=https://llms.seudominio.com
# 可选：为生成的公共资源 URL 显式覆盖公共来源。
# OMNIROUTE_PUBLIC_BASE_URL=https://llms.seudominio.com

# === 云同步（可选）===
# CLOUD_URL=https://cloud.omniroute.online
# NEXT_PUBLIC_CLOUD_URL=https://cloud.omniroute.online
EOF

⚠️ 重要：请生成唯一的密钥！对每个密钥分别使用 openssl rand -hex 32。

2.3 启动容器

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 验证其是否正在运行

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

它应显示：[DB] SQLite database ready 和 listening on port 20128。

---

3. 配置 nginx（反向代理）

3.1 生成 SSL 证书（Cloudflare Origin）

在 Cloudflare 控制面板中：

1. 前往 SSL/TLS → Origin Server
2. 点击 Create Certificate
3. 保留默认设置（15 年、*.yourdomain.com）
4. 复制 Origin Certificate 和 Private Key

mkdir -p /etc/nginx/ssl

# 粘贴证书
nano /etc/nginx/ssl/origin.crt

# 粘贴私钥
nano /etc/nginx/ssl/origin.key

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

3.2 Nginx 配置

cat > /etc/nginx/sites-available/omniroute << 'NGINX'
# 默认服务器 — 阻止通过 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;  # 更改为你的域名

    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;

        # WebSocket 支持
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        # SSE（服务器发送事件）— 流式 AI 响应
        proxy_buffering off;
        proxy_cache off;
        proxy_read_timeout 600s;
        proxy_send_timeout 600s;
    }
}

# HTTP → HTTPS 重定向
server {
    listen 80;
    listen [::]:80;
    server_name llms.yourdomain.com;
    return 301 https://$server_name$request_uri;
}
NGINX

请确保反向代理的流式传输超时时间与你的 OmniRoute 超时环境变量保持一致。如果提高 FETCH_TIMEOUT_MS / STREAM_IDLE_TIMEOUT_MS，请将 proxy_read_timeout / proxy_send_timeout 设置为高于相同阈值的值。

OmniRoute 使用 NEXT_PUBLIC_BASE_URL 作为面向浏览器的规范来源，用于 OAuth 回调和生成公共链接。经过身份验证的控制面板写入操作使用同源请求 和会话绑定的 CSRF 保护，因此不需要静态公共基础 URL。上面的 X-Forwarded-* 标头仍然是有用的路由元数据，但当 OAuth 或生成的浏览器链接需要明确的公共 URL 时， 它们不能替代公共 URL 设置。仅当客户端无法直接访问 OmniRoute，且你的代理会 移除并重新构建传入的转发标头时，才启用 OMNIROUTE_TRUST_PROXY。

3.3 启用并测试

# 删除默认配置
rm -f /etc/nginx/sites-enabled/default

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

# 测试并重新加载
nginx -t && systemctl reload nginx

---

4. 配置 Cloudflare DNS

4.1 添加 DNS 记录

在 Cloudflare 控制面板中，进入 DNS：

类型	名称	内容	代理
A	llms	203.0.113.10（VM IP）	✅ 已代理

4.2 配置 SSL

在 SSL/TLS → 概述 下：

• 模式：完全（严格）

在 SSL/TLS → 边缘证书 下：

• 始终使用 HTTPS：✅ 开启
• 最低 TLS 版本：TLS 1.2
• 自动 HTTPS 重写：✅ 开启

4.3 测试

curl -sI https://llms.seudominio.com/health
# 应返回 HTTP/2 200

---

5. 运维与维护

升级到新版本

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

查看日志

docker logs -f omniroute          # 实时输出
docker logs omniroute --tail 50   # 最后 50 行

手动备份数据库

# 将数据从卷复制到主机
docker cp omniroute:/app/data ./backup-$(date +%F)

# 或压缩整个卷
docker run --rm -v omniroute-data:/data -v $(pwd):/backup \
  alpine tar czf /backup/omniroute-data-$(date +%F).tar.gz /data

从备份恢复

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. 高级安全配置

将 nginx 限制为仅允许 Cloudflare IP

cat > /etc/nginx/cloudflare-ips.conf << 'CF'
# Cloudflare IPv4 地址范围 — 请定期更新
# 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

将以下内容添加到 nginx.conf 的 http {} 块中：

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

安装 fail2ban

apt install -y fail2ban
systemctl enable fail2ban
systemctl start fail2ban

# 检查状态
fail2ban-client status sshd

阻止直接访问 Docker 端口

# 阻止外部直接访问端口 20128
iptables -I DOCKER-USER -p tcp --dport 20128 -j DROP
iptables -I DOCKER-USER -i lo -p tcp --dport 20128 -j ACCEPT

# 持久化规则
apt install -y iptables-persistent
netfilter-persistent save

---

7. 部署到 Cloudflare Workers（可选）

要通过 Cloudflare Workers 进行远程访问（无需直接暴露 VM）：

# 在本地仓库中
cd omnirouteCloud
npm install
npx wrangler login
npx wrangler deploy

另请参阅 TUNNELS_GUIDE.md，了解仓库内的 Cloudflare Tunnel 操作指南。独立的 omnirouteCloud/ worker 位于单独的配套仓库中。

---

端口摘要

端口	服务	访问方式
22	SSH	公网访问（启用 fail2ban）
80	nginx HTTP	重定向 → HTTPS
443	nginx HTTPS	通过 Cloudflare Proxy
20128	OmniRoute	仅限本地主机（通过 nginx）

低内存 / 小型 VPS 优化

对于部署在小型 VPS 实例（1 GB RAM 或更少）上的情况：

• 禁用后台服务 — 设置 OMNIROUTE_DISABLE_BACKGROUND_SERVICES=1，以跳过调度器、MCP 服务器和定期维护任务。请参阅 docs/reference/ENVIRONMENT.md。
• 使用 SQLite WAL 模式 — 默认启用，可减少并发读取期间的峰值内存占用。
• 限制 V8 堆 — 设置 OMNIROUTE_MEMORY_MB（例如 512），以避免运行时校准出大于虚拟机容量的上限。请参阅 docs/reference/ENVIRONMENT.md。
• 重量级请求准入会随堆上限自动扩缩 – 设置上述 OMNIROUTE_MEMORY_MB 后，摄取字节预算（OMNIROUTE_CHAT_MAX_INFLIGHT_BYTES）会根据同一上限自动计算，因此内存受限的虚拟机会自动获得更小的并发请求预算，无需额外调优；超出预算的请求会收到可重试的 503 和 Retry-After，而不是争抢内存。仅当需要在此基础上设置硬性上限时，才应设置旧版的 OMNIROUTE_CHAT_MAX_HEAVY_IN_FLIGHT 请求数量上限。
• 避免在 VPS 上运行 next build — 在本地构建并部署独立输出（.next/standalone/）。
• 使用 top / free -m 监控 — 在 1 GB 虚拟机上，OmniRoute 空闲时通常使用 200-400 MB RSS。

---

OmniRoute 源码 (a58000c7685f)