跳转到内容

服务器快速入门

本指南搭建默认部署方式:中继独占公网 443 端口,自行终止 TLS 1.3,并通过内置 ACME 客户端从 Let’s Encrypt 获取证书。不需要 80 端口、certbot,前面也不需要任何代理。FreeBSD 请参见 FreeBSD。

  • 一台带 systemd、具有公网 IPv4 或 IPv6 地址的 Linux 主机。
  • 中继的 DNS 名称,例如 chat.example.com。
  • 公网 TCP 443 端口直达本主机。普通端口转发即可。TLS 必须在中继处终止:在中继前终止 TLS 的反向代理或 CDN 会导致证书签发失败,并让所有客户端连接失败。
  • 用于构建服务器的 Rust 工具链(参见构建与安装)。

创建 A 记录;如果主机有 IPv6,再创建 AAAA 记录:

chat.example.com. 300 IN A 203.0.113.10
chat.example.com. 300 IN AAAA 2001:db8::10

继续之前确认解析正确:

Terminal window
dig +short chat.example.com
Terminal window
curl -fsSLO https://raw.githubusercontent.com/PDG-Global/rchat-core/v2.1.1/scripts/install.sh
sudo sh install.sh

该脚本下载适合本机的发行版二进制文件,按发行的签名清单校验后安装到 /usr/local/bin/rchat-server。它还会创建 rchat 用户、/var/lib/rchat(权限 0700)和 /etc/rchat,并安装 systemd 单元。它从不覆盖已有的配置、密钥或单元。选项、手动校验和从源代码构建参见安装(英文)。

生成一个随机的 WebSocket 路径。只有升级到这个确切路径的请求才能到达中继,其他所有请求都会得到一个伪装网站:

Terminal window
echo "/$(openssl rand -base64 24 | tr '+/' '-_')"

创建 /etc/rchat/server.toml:

[server]
bind_addr = "0.0.0.0:443"
websocket_path = "/paste-the-random-path-here"
relay_identity_path = "/var/lib/rchat/relay_identity.key"
[server.acme]
enabled = true
domains = ["chat.example.com"]
contacts = ["mailto:[email protected]"]
cache_dir = "/var/lib/rchat/acme"
staging = true
Terminal window
sudo install -m 0640 -g rchat server.toml /etc/rchat/server.toml

必须设置 websocket_path。仓库中的模板写的是 /CHANGE-ME-to-a-long-random-path,路径中仍含 CHANGE-ME 时服务器会拒绝启动。每个配置项都必须拼写正确:未知配置项会让服务器停止。

staging = true 先获取一张不受信任的测试证书,这样 DNS 或防火墙的错误不会耗尽 Let’s Encrypt 的生产环境限额。第 7 步中再关闭它。

发给离线接收方的消息最多保存 72 小时。默认情况下它们只保存在内存中,不会写入磁盘。如需更改,参见离线队列。

中继拥有一个长期身份密钥,与 TLS 证书相互独立。应用会在首次连接时固定它。请在首次启动前,以服务用户身份创建一次:

Terminal window
sudo -u rchat /usr/local/bin/rchat-server --config /etc/rchat/server.toml --init-relay-identity

该命令会写入 /var/lib/rchat/relay_identity.key,并打印中继的固定值(rk:1:…)。从配置文件启动的中继在缺少该密钥时会拒绝启动,而 --init-relay-identity 从不覆盖已有密钥。请像备份 TLS 私钥一样备份它。公布固定值和轮换密钥参见中继身份。

install.sh 已将 systemd 单元安装为 /etc/systemd/system/rchat-server.service。它以非特权用户 rchat 运行,通过 CAP_NET_BIND_SERVICE 绑定 443 端口,并保持 /var/lib/rchat 的权限为 0700。启动它:

Terminal window
sudo systemctl daemon-reload
sudo systemctl enable --now rchat-server

如果防火墙尚未开放 443/tcp,请开放它。

Terminal window
journalctl -u rchat-server -f

您应依次看到:

WARN ACME: no certificate cached yet. TLS handshakes will FAIL until Let's Encrypt issues one ...
INFO WebSocket server listening on 0.0.0.0:443 (TLS 1.3)
INFO ACME: certificate issued and deployed; TLS is ready

最后一行出现之前,TLS 握手都会失败,不存在临时证书。如果签发失败,中继会继续运行并重试,参见 TLS 与证书。

测试证书签发成功后,在 /etc/rchat/server.toml 中设置 staging = false 并重启:

Terminal window
sudo systemctl restart rchat-server

检查结果:

Terminal window
openssl s_client -connect chat.example.com:443 -servername chat.example.com </dev/null 2>/dev/null \
| openssl x509 -noout -issuer -dates

颁发者中不应再包含 STAGING。续期是自动的,无需重启。

在 rChat 应用中,将服务器 URL 设为主机名加 WebSocket 路径:

wss://chat.example.com/paste-the-random-path-here

连接一次以检查部署。如果应用提示 “This server couldn’t prove its identity”,说明中继前面有东西在终止 TLS。

同时把中继的固定值交给用户,让他们在连接设置中输入,而不必信任首次连接:

Terminal window
sudo -u rchat /usr/local/bin/rchat-server --config /etc/rchat/server.toml --print-relay-pin

邀请是一条链接,以二维码形式显示,用于为您的中继设置 rChat:它包含中继的地址(含秘密的 WebSocket 路径)和中继的身份固定值。以服务用户身份打印邀请:

Terminal window
sudo -u rchat /usr/local/bin/rchat-server --config /etc/rchat/server.toml --print-invite
# FreeBSD:
su -m rchat -c '/usr/local/bin/rchat-server --config /usr/local/etc/rchat/server.toml --print-invite'

该命令打印链接(rchat://relay?u=…&pin=…),并在终端中画出二维码。主机名取自 [server.decoy] 下的 host,否则取第一个 [server.acme] 域名;两者都没有时,命令会停止并提示您设置 host。客户端连接 443 端口时,链接中省略端口。如果客户端连接的端口与中继绑定的端口不同(例如在 NAT、pf rdr 规则或 jail 之后),请在 [server] 下设置 public_port(或传入 --public-port);未设置时,中继在 PROXY 协议前端之后假定为 443,否则使用自己的绑定端口。

在应用中,用户在连接界面或”设置 → 连接”中点按 Scan relay invite(或用链接点按 Paste invite)。应用会显示中继的主机名,并在保存任何内容之前先询问。随后它立即固定中继的身份,因此即使是首次连接,以不同身份应答的中继也会被拒绝。已连接的用户可以在”设置 → 连接 → Invite someone to this relay”中再次分享邀请。

任何持有此邀请的人都能连接到您的中继,但无法阅读消息。请只把它分享给您希望使用该中继的人,不要放在公开页面或日志中:中继从不记录它,install.sh 只打印命令,provision.sh 只在终端中运行时才打印邀请(否则只打印命令)。