跳转到内容

以服务方式运行

每个版本都会发布两个 systemd 单元(位于 https://assets.r-chat.net/<版本>/,下面的命令以 2.1.1 为例):

单元部署方式
rchat-server.service默认(direct 单元,install.sh 安装的就是它)。 中继占用 443 端口并自行终止 TLS,使用 [server.acme] 或 [server.tls]。
rchat-server-proxy.service中继在 127.0.0.1:8443 上自行终止 TLS,位于发送 PROXY 协议 v2 的 TCP 透传之后。参见 TCP 前端部署。

两个单元都不会在没有 TLS 的情况下运行中继。FreeBSD 请参见 FreeBSD。

install.sh 会安装 direct 单元并创建用户和目录。手动安装:

Terminal window
sudo useradd --system --user-group --home-dir /var/lib/rchat --no-create-home --shell /usr/sbin/nologin rchat
sudo install -d -m 0700 -o rchat -g rchat /var/lib/rchat
sudo -u rchat /usr/local/bin/rchat-server --config /etc/rchat/server.toml --init-relay-identity
curl -fsSL -o rchat-server.service https://assets.r-chat.net/2.1.1/rchat-server.service
sudo install -m 0644 rchat-server.service /etc/systemd/system/rchat-server.service
sudo systemctl daemon-reload
sudo systemctl enable --now rchat-server

请在配置文件中设置 relay_identity_path = "/var/lib/rchat/relay_identity.key",让密钥位于该单元唯一可写的目录中。参见中继身份。

本站各页面将该单元称为 rchat-server。如果以原名安装 behind-proxy 单元,请在命令中改用 rchat-server-proxy。

  • 以 rchat 而不是 root 运行。 ExecStart=/usr/local/bin/rchat-server --config /etc/rchat/server.toml,不带 --no-tls。
  • 无需 root 即可绑定 443 端口。 它授予 AmbientCapabilities=CAP_NET_BIND_SERVICE,capability 边界集中没有其他内容。
  • 保持状态私密。 StateDirectory=rchat 使 /var/lib/rchat 保持 0700 权限,UMask=0077 让服务创建的每个文件只有属主可访问。该目录存放 ACME 缓存、中继身份密钥,以及(如启用)加密的队列文件。
  • 把队列密钥放在内存中。 RuntimeDirectory=rchat 是位于 /run/rchat 的 tmpfs,服务重启时保留、机器重启时清除(RuntimeDirectoryPreserve=yes)。每次启动前,如果缺少 /run/rchat/queue.key,单元会创建它,供加密队列持久化使用。
  • 处于沙箱中:
    • ProtectSystem=strict、ProtectHome=true 和 ReadWritePaths=/var/lib/rchat;
    • PrivateTmp、PrivateDevices、ProtectClock、ProtectHostname、ProtectKernelTunables、ProtectKernelModules、ProtectKernelLogs、ProtectControlGroups 和 ProtectProc=invisible;
    • NoNewPrivileges、RestrictSUIDSGID、RestrictRealtime、RestrictNamespaces、LockPersonality 和 MemoryDenyWriteExecute;
    • RestrictAddressFamilies=AF_INET AF_INET6 AF_UNIX,以及去掉 @privileged @resources 的 SystemCallFilter=@system-service。
  • 限制资源。 LimitNOFILE=1048576(请让它远高于 max_connections)、MemoryMax=3G(如果调高队列预算请相应调高),并且不生成核心转储(LimitCORE=0;中继自身也会禁用)。
  • 永不放弃重启。 Restart=on-failure 配合 StartLimitIntervalSec=0。重启间隔在 10 次重启内从 5 秒退避到 60 秒(RestartSteps=10、RestartMaxDelaySec=60,需要 systemd 254 或更新版本;旧版本保持固定的 RestartSec=5)。

由于 ProtectSystem=strict,中继只能写入 /var/lib/rchat 和 /run/rchat。请把 cache_dir、relay_identity_path 和 persist_path 放在 /var/lib/rchat 下,把 persist_key_path 放在 /run/rchat 下。/etc/rchat 对服务只读,这对配置文件和静态证书来说没有问题。

Terminal window
sudo systemctl status rchat-server
sudo systemctl restart rchat-server # 修改 server.toml 后
sudo systemctl reload rchat-server # SIGHUP:重新加载静态证书
journalctl -u rchat-server -f # 跟踪日志

重载时中继不会重新读取 server.toml。SIGHUP 只重新加载静态证书文件,在 ACME 模式下什么也不做。要应用配置更改,请重启。

FreeBSD 请使用 FreeBSD 页面中的 rc.d 脚本。在其他系统上,请以可以绑定 443 端口的非特权用户运行相同命令:

Terminal window
/usr/local/bin/rchat-server --config /etc/rchat/server.toml

请把 ACME 缓存和中继身份密钥放在只有该用户能读取的持久存储上。