快速开始

私有阁 Siyouge 是一套可私有化部署的即时通讯系统：一个 Node.js 服务端，配套安卓 / iOS / H5 / PC 多端客户端。本文帮助你在 10 分钟内把服务端跑起来，并让客户端连上它。

私有阁以「源码包」方式交付。收到交付内容后，你会得到结构清晰的工程目录，所有代码完整可编译、可修改、可二次分发到你自己的客户：

siyouge/
├─ server/        # Node.js 服务端（必部署）
├─ android/       # 安卓客户端源码工程
├─ ios/           # iOS 客户端源码工程
├─ h5/            # H5 网页端
└─ docs/          # 部署与二次开发文档

准备项目

准备一台干净的 Linux 服务器（推荐 Ubuntu 22.04，2 核 4G 起步），并安装：

把源码包解压到同一父目录，例如 /www/siyouge/。以下命令均以该目录为例。

启动服务端

进入服务端目录并安装依赖（国内服务器建议配置 npm 镜像以加速）：

cd /www/siyouge/server
npm install

复制 .env.example 为 .env，按你的环境修改核心配置：

PORT=3000
HOST=127.0.0.1
DB_HOST=127.0.0.1
DB_PORT=3306
DB_USER=siyouge
DB_PASSWORD=你的数据库密码
DB_NAME=siyouge
JWT_SECRET=请替换为足够长的随机字符串

启动服务：

node server.js

看到「服务器运行在 http://127.0.0.1:3000」即启动成功。内置健康检查接口可直接验证：

curl http://127.0.0.1:3000/api/health

启动客户端

• 安卓：用 Android Studio 打开 android/ 工程，编译安装到真机，在登录页填入服务器地址即可登录。
• iOS：用 Xcode 打开 ios/imm.xcworkspace，配置签名后运行，同样在登录页填写服务器地址。
• H5：把 h5/ 构建产物部署到 Nginx，并将 API 地址指向你的服务端（详见「H5 客户端部署」）。

验证与下一步

注册两个测试账号并互发消息，确认实时送达；再分别在第二台设备登录同一账号，验证多端消息漫游。下一步建议阅读「后端部署」完成生产级配置（进程守护、HTTPS、反向代理），再按需开启音视频中继与推送。