VoceChat -聊天程序部署

VoceChat 是一款支持独立部署的个人云社交媒体聊天服务。15MB 的大小可部署在任何的服务器上，部署简单，很少需要维护。前端可以内嵌到自己的网站下，数据完全由用户自己掌握，传输过程加密。VoceChat 从 Slack, Discord, RocketChat, Solid, Matrix 等产品和规范中博采众长，适用于团队交流，个人聊天服务，网站客服，网站内嵌社区的场景。

我们认为 Web 3.0 去中心化的第一步是基于个人云的去平台化，通过个性化的计算与个性化的存储，让个人和组织拥有自己的平台，所以 VoceChat 的定位是能轻易部署在私有云上的社交协作程序。

团队国际化，远程合作，贡献者来自中、美、巴西等地区, VoceChat 是一个开放的、赋能用户的产品，欢迎大家点 star 关注，提 issues，或者以其他形式参与贡献。

Docker安装

重要提示

请确认你的系统架构：默认安装 linux/amd64，如果是 linux/arm64，请拉取privoce/vocechat-server:latest-arm64

本地快速体验

提示

假如没有服务器，但是在本地电脑装有 Docker，可以执行以下命令行，快速体验 VoceChat

docker run -d --restart=always \
  -p 3009:3000 \
  --name vocechat-server \
  privoce/vocechat-server:latest

浏览器访问: http://localhost:3009/

服务器部署

提示

请提前准备好一个域名，以下用vocechat.yourdomain.com举例

Docker + Nginx

运行VoceChat

docker run -d --restart=always \
  -p 3009:3000 \
  --name vocechat-server \
  -v ~/.vocechat-server/data:/home/vocechat-server/data \
  privoce/vocechat-server:latest \
  --network.frontend_url "https://vocechat.yourdomain.com"

提示

  • -v ~/.vocechat-server/data:/home/vocechat-server/data目的是将docker内的数据映射出来，作用是后续vocechat-server升级同时保留已有数据，~/.vocechat-server/data只是举例，可自行定义。
  • network.frontend_url用于生成邀请链接，发送邀请邮件等场景，为可选参数，是个带网络协议的域名，所以不要忘了根据实际情况加协议http(s)。如果部署时未指定，也可在初始化Server流程时设置。

配置 Nginx http 反向代理

在 Nginx 配置文件目录（一般在/etc/nginx/conf.d）新建 Nginx 配置文件vocechat.yourdomain.com.conf，并配置好 http 请求：

server{
  server_name vocechat.yourdomain.com;
  location / {
        proxy_pass http://127.0.0.1:3009; # 此处端口号取决于docker运行的对外端口号
        proxy_redirect off;
        proxy_set_header        Host    $host;
        proxy_set_header        X-Real-IP       $remote_addr;
        proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;
        proxy_max_temp_file_size 0; # 关掉硬盘缓存，增加写速度
        # SSE 相关配置
        proxy_http_version 1.1;
        proxy_set_header Connection '';
    }
}

检查配置文件的语法：nginx -t，没问题后，启用新增配置：nginx -s reload。此时，浏览器访问http://vocechat.yourdomain.com，能够进入初始化页面，即为配置成功。

Docker

提示

如果你的服务器没有被其它服务占用 https 端口（即 443），可以考虑该方式，否则，请参考 Docker + Nginx

vocechat-server 支持自动申请 https 证书（借助CertBot），使用该部署方式有两个前提：

  • 服务器 443 端口没有被占用
  • 准备一个域名，并已解析到该服务器 IP。
mkdir -p ~/.vocechat-server/data
docker run -d --restart=always \
  -p 443:443 \
  --name vocechat-server \
  -v ~/.vocechat-server/data:/home/vocechat-server/data \
  privoce/vocechat-server:latest \
  --network.bind "0.0.0.0:443" \
  --network.domain "vocechat.yourdomain.com" \
  --network.tls.type "acme_tls_alpn_01" \
  --network.tls.acme.cache_path "/home/vocechat-server/data/cert"

参数说明:

  • network.bind: 服务端绑定的 IP 和端口，0.0.0.0 为所有 IP
  • network.domain: 域名
  • network.type: TLS 验证方式，这里为 acme_tls_alpn_01，更多请参考代码目录 config/config.toml 。
  • network.tls.acme.cache_path: 证书存放位置。
  • network.tls.acme.directory_url: 默认的验证机构，可选，默认 https://acme-v02.api.letsencrypt.org/directory。

访问:https://vocechat.yourdomain.com/，完成初始化 。

如果 80/443 端口被 Nginx 占用, 请参考 Docker + Nginx

其他相关命令

停止服务

docker stop vocechat-server

查看日志

docker logs -f vocechat-server

备份数据

cp -rf ~/.vocechat-server/data ~/.vocechat-server/backup

升级server版本（更新docker镜像）

docker stop vocechat-server
docker rm vocechat-server
docker pull privoce/vocechat-server:latest

# 这里改为自己之前部署执行过的docker命令行
docker run -d --restart=always \
  -p 3009:3000 \
  --name vocechat-server \
  -v ~/.vocechat-server/data:/home/vocechat-server/data \
  privoce/vocechat-server:latest \
  --network.frontend_url "https://vocechat.yourdomain.com"

进入 Docker

docker exec -it vocechat-server /bin/sh
cd /home/vocechat-server/data

参考：https://doc.voce.chat/zh-cn/install/install-by-docker

Shell脚本安装

提示

  • 该安装方式适用于小型设备（比如树莓派、NAS 等设备），或者想最大化性能的极客。
  • 基本原理是直接运行二进制的方式，目前支持 Linux x86_64, Arm32, Aarch64 架构。
  • 确保您的系统目录 /etc/init.d 存在，并且可写。

安装

在安装的过程中，会询问绑定的端口，域名，和是否启用 TLS（会自动申请证书）。 这里要注意的是，如果你要开启 TLS，那么端口必须为 443，也就意味着你的 vocechat-server 必须独占 443。

curl -sSf https://s.voce.chat/install.sh | sh

启动

/etc/init.d/vocechat-server.sh start

停止

/etc/init.d/vocechat-server.sh stop

查看日志

/etc/init.d/vocechat-server.sh log

https://github.com/Privoce/vocechat-web

https://doc.voce.chat/zh-cn/