-
Notifications
You must be signed in to change notification settings - Fork 1k
sk‐Fly io Deployment Guide
🇸🇰 Slovenčina | 🇺🇸 English | Language Hub
🌐 Languages: 🇺🇸 English · 🇸🇦 ar · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇪🇸 es · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇳 gu · 🇮🇱 he · 🇮🇳 hi · 🇭🇺 hu · 🇮🇩 id · 🇮🇹 it · 🇯🇵 ja · 🇰🇷 ko · 🇮🇳 mr · 🇲🇾 ms · 🇳🇱 nl · 🇳🇴 no · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇸🇰 sk · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇻🇳 vi · 🇨🇳 zh-CN
本文档记录 OmniRoute 在 Fly.io 上的实际部署方法,适用于两类场景:
- 首次把当前项目部署到 Fly.io
- 后续代码更新后继续发布
- 新项目参考同样流程部署
本文基于当前项目已经验证通过的配置整理,应用名为 omniroute。
- 平台:Fly.io
- 部署方式:本地
flyctl直接发布 - 运行方式:使用仓库内现有
Dockerfile和fly.toml - 数据持久化:Fly Volume 挂载到
/data - 访问地址:
https://omniroute.fly.dev/
当前仓库中的 fly.toml 已确认包含以下关键项:
app = 'omniroute'
primary_region = 'sin'
[[mounts]]
source = 'data'
destination = '/data'
[processes]
app = 'node run-standalone.mjs'
[http_service]
internal_port = 20128
[env]
TZ = "Asia/Shanghai"
HOST = "0.0.0.0"
HOSTNAME = "0.0.0.0"
BIND = "0.0.0.0"说明:
-
app = 'omniroute'决定实际部署到哪个 Fly 应用 -
destination = '/data'决定持久卷挂载目录 - 本项目必须让
DATA_DIR=/data,否则数据库和密钥会写到容器临时目录
Windows PowerShell:
pwsh -Command "iwr https://fly.io/install.ps1 -useb | iex"如果安装脚本在当前环境失败,也可以手动下载 flyctl 二进制并放到 PATH 中。
flyctl auth loginflyctl auth whoami
flyctl versiongit clone https://github.com/diegosouzapw/OmniRoute.git
cd OmniRoute打开 fly.toml,重点看这一行:
app = 'omniroute'如果你准备部署到自己的新应用,可改成全局唯一名称,例如:
app = 'omniroute-yourname'注意:
- 控制台里要看的是与
fly.toml里app一致的应用 - 以前如果用过别的名字,例如
oroute,不要和omniroute混淆
如果该应用尚不存在:
flyctl apps create omniroute如果你已经改成别的应用名,把 omniroute 替换成你的名字。
flyctl deploy本项目在 Fly.io 上建议至少配置以下参数。
这些参数已经在当前 omniroute 应用上实际部署:
API_KEY_SECRETDATA_DIRJWT_SECRETMACHINE_ID_SALTNEXT_PUBLIC_BASE_URLSTORAGE_ENCRYPTION_KEY
当前项目没有设置 INITIAL_PASSWORD,因为本次部署按需求不使用它。
如果不设置:
- 启动日志会提示默认密码是
CHANGEME - 部署后应尽快在系统设置中修改登录密码
如果你希望无人值守初始化后台密码,也可以后续补:
INITIAL_PASSWORD
建议放入 Fly Secrets:
| 变量名 | 是否推荐 | 说明 |
|---|---|---|
API_KEY_SECRET |
必需 | API Key 生成与校验使用 |
JWT_SECRET |
必需 | 登录态和 JWT 签名使用 |
STORAGE_ENCRYPTION_KEY |
强烈推荐 | 加密存储敏感连接信息 |
MACHINE_ID_SALT |
推荐 | 生成稳定机器标识 |
INITIAL_PASSWORD |
可选 | 首次部署时直接指定后台初始密码 |
| OAuth/API 私密凭证 | 按需 | 各类外部平台鉴权配置 |
| 变量名 | 推荐值 |
|---|---|
DATA_DIR |
/data |
NEXT_PUBLIC_BASE_URL |
https://omniroute.fly.dev |
说明:
-
DATA_DIR=/data非常关键,必须与 Fly Volume 挂载点一致 -
NEXT_PUBLIC_BASE_URL用于调度器和前端回调等场景
下面命令会生成安全随机值,并把当前项目需要的参数一次性写入 Fly Secrets。
说明:
- 不包含
INITIAL_PASSWORD - 适用于当前项目
omniroute
$apiKeySecret = [Convert]::ToHexString((1..32 | ForEach-Object { Get-Random -Minimum 0 -Maximum 256 })).ToLower()
$jwtSecret = [Convert]::ToHexString((1..64 | ForEach-Object { Get-Random -Minimum 0 -Maximum 256 })).ToLower()
$machineIdSalt = [Convert]::ToHexString((1..32 | ForEach-Object { Get-Random -Minimum 0 -Maximum 256 })).ToLower()
$storageKey = [Convert]::ToHexString((1..32 | ForEach-Object { Get-Random -Minimum 0 -Maximum 256 })).ToLower()
flyctl secrets set `
API_KEY_SECRET=$apiKeySecret `
JWT_SECRET=$jwtSecret `
MACHINE_ID_SALT=$machineIdSalt `
STORAGE_ENCRYPTION_KEY=$storageKey `
DATA_DIR=/data `
NEXT_PUBLIC_BASE_URL=https://omniroute.fly.dev `
-a omniroute如果你还要加初始密码:
flyctl secrets set INITIAL_PASSWORD=你的强密码 -a omnirouteflyctl secrets list -a omniroute如果控制台 Secrets 页面没有显示你期待的变量,先检查:
- 看的应用是不是
omniroute -
fly.toml的app是否和控制台应用一致
代码有更新后,发布步骤很简单:
git pull
flyctl deploy如果只更新参数,不改代码:
flyctl secrets set KEY=value -a omnirouteFly 会自动滚动更新机器。
如果当前仓库是 fork,并且你要同步上游 https://github.com/diegosouzapw/OmniRoute 的更新,推荐按下面流程执行。
先确认远程:
git remote -v应至少包含:
-
origin指向你自己的 fork -
upstream指向原仓库
如果没有 upstream,先添加:
git remote add upstream https://github.com/diegosouzapw/OmniRoute.git同步上游前,先抓取最新提交和标签:
git fetch upstream --tags查看当前版本和上游标签:
git describe --tags --always
git show --no-patch --oneline v3.4.7如果你想合并上游最新 main,并强制保留 fork 当前的 fly.toml,可按下面流程执行:
git merge upstream/main
git checkout HEAD~1 -- fly.toml
git add -- fly.toml
git commit -m "chore(deploy): keep fork fly.toml"
git push origin main说明:
-
git merge upstream/main用于同步原仓库最新代码 -
git checkout HEAD~1 -- fly.toml用于恢复合并前你 fork 自己的fly.toml - 如果上游没有改
fly.toml,这一步不会带来额外差异 - 如果上游改了
fly.toml,这一步能确保 Fly 应用名、挂载卷、区域等 fork 自定义部署配置不被覆盖
如果你明确只想对齐某个发布标签,例如 v3.4.7,也可以先确认标签是否已经包含在 upstream/main:
git merge-base --is-ancestor v3.4.7 upstream/main返回成功表示 upstream/main 已经包含该版本,直接合并 upstream/main 即可。
同步原仓库完成后,推荐按下面顺序发布:
git fetch upstream --tagsgit merge upstream/main- 恢复 fork 的
fly.toml git push origin mainflyctl deployflyctl status -a omnirouteflyctl logs --no-tail -a omniroute
这就是当前项目升级到 v3.4.7 时使用的实际流程。
flyctl status -a omnirouteflyctl logs --no-tail -a omniroutetry {
(Invoke-WebRequest -Uri "https://omniroute.fly.dev" -MaximumRedirection 5 -UseBasicParsing).StatusCode
} catch {
if ($_.Exception.Response) {
$_.Exception.Response.StatusCode.value__
} else {
throw
}
}返回 200 说明站点已正常响应。
部署成功后,日志里应看到类似内容:
[bootstrap] Secrets persisted to: /data/server.env
[DB] SQLite database ready: /data/storage.sqlite
这两个点很关键:
-
/data/server.env说明运行时密钥落到了持久卷 -
/data/storage.sqlite说明数据库写入持久卷
如果你看到的是 /app/data/...,说明 DATA_DIR 没配对,需要立即修正。
通常有两种原因:
- 你还没执行
flyctl secrets set - 你打开的是另一个应用,例如
oroute,不是omniroute
先创建应用:
flyctl apps create omniroute重点检查:
- 注释里是否有乱码字符
- TOML 引号和缩进是否正确
检查以下两点:
-
fly.toml中是否存在destination = '/data' -
DATA_DIR是否设置为/data
可以运行,但会回退到默认 CHANGEME。生产环境建议尽快修改后台密码。
如果以后是新项目照着这份文档部署,最少改这几项:
- 修改
fly.toml里的app - 修改
NEXT_PUBLIC_BASE_URL - 保持
DATA_DIR=/data - 重新生成
API_KEY_SECRET、JWT_SECRET、MACHINE_ID_SALT、STORAGE_ENCRYPTION_KEY - 首次部署后检查日志是否写入
/data
不要直接复用旧项目的密钥。
当前项目后续最常用的命令如下:
flyctl auth whoami
flyctl status -a omniroute
flyctl secrets list -a omniroute
flyctl deploy
flyctl logs --no-tail -a omniroute如果只是正常发版,核心就是:
flyctl deploy如果是新环境首次部署,核心就是:
flyctl auth loginflyctl apps create omnirouteflyctl secrets set ... -a omnirouteflyctl deployflyctl logs --no-tail -a omniroute
OmniRoute · Website · npm · Docker Hub
- Setup Guide
- User Guide
- Features
- Quick Start (Docker)
- Electron Desktop App
- Termux (Android)
- PWA Guide
- MCP Server
- A2A Server
- Agent Protocols
- OpenCode Plugin
- Webhooks
- Cloud Agents
- Skills
- Memory
- Evals
- Gamification
- Guardrails
- Compliance
- Error Sanitization
- Public Credentials
- Route Guard Tiers
- Stealth Guide
- CLI Token Auth