安装
中继是一个二进制文件 rchat-server。Linux、FreeBSD 和 macOS 的发行版二进制文件发布在 https://assets.r-chat.net/<版本>/,每个都附有 SHA-256 校验和。当前版本见版本发布(英文)和下载页面。
使用 install.sh 安装
Section titled “使用 install.sh 安装”安装脚本来自公开 rchat-core 仓库的发行标签,而不是下载主机:发行公钥和回滚下限在打标签时就编译进了脚本,下载主机的写入权限无法改变它们。在 Linux 上(以 root 或通过 sudo):
curl -fsSLO https://raw.githubusercontent.com/PDG-Global/rchat-core/v2.1.1/scripts/install.shless install.sh # 运行前先读一遍sudo sh install.sh在 FreeBSD 上请以 root 身份运行(可能没有安装 sudo)。基本系统不含 curl,请先安装(install.sh 使用 curl,因为它能让所有重定向都保持 https):
pkg install -y curlcurl -fsSLO https://raw.githubusercontent.com/PDG-Global/rchat-core/v2.1.1/scripts/install.shless install.sh # 运行前先读一遍sh install.sh在 FreeBSD 上编写 /usr/local/etc/rchat/server.toml 时,中继身份密钥写在 [server] 下;使用内置 ACME 时,证书缓存写在 [server.acme] 下,两者都放在 /var/db/rchat。请显式设置 cache_dir:默认路径 /var/lib/rchat/acme 在 FreeBSD 上不存在,中继会拒绝启动。
[server]relay_identity_path = "/var/db/rchat/relay_identity.key"
[server.acme]cache_dir = "/var/db/rchat/acme"脚本会选择适合本机的二进制文件,先获取发行的签名清单(SHA256SUMS.txt 及其签名 SHA256SUMS.txt.sig),用编译进脚本的发行公钥通过 ssh-keygen 验证签名,再按已验证的清单核对下载文件的哈希——不会退回到从下载主机获取的单个校验和。签名无效、清单版本不符或版本低于编译进脚本的回滚下限(2.1.1)时拒绝安装(退出码 3,不安装任何东西)。校验需要 ssh-keygen(OpenSSH 8.0 及以上;FreeBSD 基本系统自带)。脚本把二进制文件安装到 /usr/local/bin/rchat-server,并创建服务用户、目录和服务文件。它从不覆盖已有的配置、中继身份密钥或服务文件。 选项、退出码、FreeBSD 与 macOS 的步骤和手动安装命令请参见英文页面。
从源代码构建
Section titled “从源代码构建”源代码位于公开的 rchat-core 仓库。您需要 Rust 工具链(rustup)以及 C 工具链和 CMake:中继依赖共享客户端库,它通过 boring crate 编译 BoringSSL。
git clone https://github.com/PDG-Global/rchat-core.gitcd rchat-core/rchatcargo build --release --locked --bin rchat-serversudo install -m 0755 target/release/rchat-server /usr/local/bin/然后编写 /etc/rchat/server.toml,创建一次中继身份,再安装 systemd 单元,快速入门和以服务方式运行中有完整步骤。FreeBSD 请参见 FreeBSD。
检查二进制文件
Section titled “检查二进制文件”rchat-server --help显示命令行参数,各参数含义见命令行参考。
再次运行 install.sh(或手动替换二进制文件),然后重启:
sudo systemctl restart rchat-server/var/lib/rchat/acme 中的 ACME 缓存和中继身份密钥在重启后保留,中继会继续使用已有证书并保持原有身份。
排队的离线消息默认保存在内存中,因此重启会丢失它们。如需在重启后保留,请开启加密持久化(参见离线队列)。
升级到 2.1.1
Section titled “升级到 2.1.1”2.1.1 是一个安全版本:安全修复和依赖更新。中继运营者应当更新。再次运行上面带标签的安装脚本并重启即可;配置、中继身份和 ACME 缓存都会保留。安装脚本会拒绝低于其编译回滚下限的版本,请使用当前标签的安装脚本。
升级到 2.1.0(通话)
Section titled “升级到 2.1.0(通话)”语音和视频通话需要 2.1.0 版中继。中继会向应用声明通话能力 calls-v1(语音)和 video-v1(视频)。中继较旧时,rChat Android 版会显示“Your relay needs an update for calls”。消息不受影响。iPhone 通话尚未发布,发布后同样需要 2.1.0。
- 同一端口,无需额外配置。 通话使用中继自己的 HTTPS 端口,没有额外端口,也没有单独的通话服务器。
- 前置代理。 TCP(第 4 层)透传对通话和对消息一样有效;参见TCP 前置代理。
- 带宽。 中继会转发每路通话的媒体,因此通话会在中继上占用双向带宽。语音是恒定的数据流(应用以 24 kbps 编码,连接较差时降到 16 kbps)。视频占用更多,并随画面和网络状况变化。通话中每部手机会额外打开两个连接(视频时为四个)。
- 指标。 中继导出以
rchat_media_为前缀的通话计数器,例如rchat_media_connections_active、rchat_media_frames_forwarded_total、rchat_media_video_connections_active和rchat_media_join_refused_total。它们是整个中继的总数,没有按人或按通话的数据。 - 心跳与暂存副本。 2.1.0 还改变了中继何时对安静连接发送 ping,并新增两个可选配置项
held_copy_max_bytes_per_connection和held_copy_max_total_bytes(参见服务器配置项)。如果把connection_timeout_secs设得低于300,中继启动时会记录警告。
离线存储限制
Section titled “离线存储限制”离线存储的限制有变化。请在配置文件中注意:
- 旧配置项已改名。
[server]下的offline_queue_max_bytes_per_recipient现在是[server.offline_queue]下的max_bytes_per_recipient。旧配置项在一个版本内仍然有效:中继启动时记录警告,并在新配置项未设置时使用旧值;两者都设置时以新配置项为准。请在下个版本之前改名,届时旧配置项将不再被解析。 - 新默认值。 每个接收方账号 4 MiB 和 256 条消息(
max_bytes_per_recipient、max_messages_per_recipient;此前为 16 MiB 和 1000 条)。全局的offline_queue_max_total_bytes仍为 256 MiB。新增按发送方的预算:sender_budget_bytes为 16 MiB,sender_budget_messages为 1024,sender_window_secs等于ttl_secs(不能更短),sender_source_budget_multiplier为 4。
对用户的影响:在队列的存活期内(最多 72 小时),向离线联系人发送的内容,每个连接最多约 16 MiB,每个网络地址最多约 64 MiB。共用同一个办公室或运营商地址的人共享该地址的预算。正常聊天不会察觉;但向离线联系人连续发送大量照片或文件时,可能被拒绝:发送方收到 RateLimited 错误且没有确认。已排队的消息不会被丢弃。你可以在 限制 和 服务器配置项 给出的范围内调高这些数值。被拒绝的消息会在 rchat_rejections_total 中以 offline_recipient_cap、offline_sender_budget 和 offline_source_budget 计数。
升级到协议第 2 版
Section titled “升级到协议第 2 版”协议第 2 版是一次硬切换:请同时更新中继和应用。中继会拒绝旧版应用,在更新之前它们无法连接。