快速部署
这条路径用最短步骤把 Keragi 服务端和 Web 客户端跑起来。更完整的安装、配置与运维说明见后续页面。
1. 前置条件
- Linux x86_64(当前服务端宿主只提供该平台)
- Node.js 18 或更高版本
- 一个可写的部署目录
- 数据库默认使用 SQLite,无需额外安装
其他服务器平台(Windows、macOS、ARM64、ESP32 等)与外部数据库将在后续版本支持,详见运行环境与数据库。
2. 安装服务端宿主
从下载页获取 keragi-wasmx-linux-x64.tgz,与所需资源包放在同一目录,然后安装:
npm install -g ./keragi-wasmx-linux-x64.tgz
当前版本使用下载页的
.tgz离线安装;npm 目前提供宿主与 userx,其他资源包将在后续版本提供。
3. 初始化部署目录
wasmx init ./keragi-deploy
cd keragi-deploy
cp .env.example .env
编辑 .env:
JWT_SECRET:至少 32 位随机字符,宿主与userx共用BOOTSTRAP_ADMIN_CREDENTIAL/BOOTSTRAP_ADMIN_PASSWORD:初始管理员USERX_ADMIN_URL/USERX_PUBLIC_URL:宿主访问userx的地址WASMX_ADDR:监听地址,默认127.0.0.1:3001
4. 按需安装 WASM 资源
宿主与每个 WASM 资源都是独立包,可以按服务器类型任意组合。
主服务器常见组合:
wasmx add ../keragi-resx.tgz
wasmx add ../keragi-msgx.tgz
wasmx add ../keragi-userx.tgz
连接器服务器:
wasmx add ../keragi-conn.tgz
AI 服务器:
wasmx add ../keragi-agix.tgz
也可以使用 preset 一次安装:
wasmx init ./connector --preset connector --offline .. # 宿主 + conn
wasmx init ./main --preset main --offline .. # 宿主 + resx + msgx + userx
wasmx init ./full --preset full --offline .. # 宿主 + 全部资源
--offline 指向存放 .tgz 的目录;上例假设资源包与部署目录在同一层。
5. 启动与验证
wasmx start
wasmx status
宿主默认监听 http://127.0.0.1:3001,可以用 /status 检查:
curl http://127.0.0.1:3001/status
日志在部署目录的 wasmx.log,数据库默认在 data/。
6. 部署 Web 客户端
从下载页获取 keragi-app-web.tar.gz:
- 解压后把
dist/交给任意静态服务器(需要 SPA fallback 到index.html)。 - 复制
config.example.json为dist/config.json。 - 把
services里的userx、msgx、agix、conn改成你的服务端地址。 - 重新加载页面。