运行服务器

本指南面向安装和运行 Antimatter 服务器的系统管理员。我们假设你熟悉 Linux、Docker 和反向代理,但不一定了解 Antimatter。

部署的组成部分

Antimatter 是一款自托管的团队聊天应用,是 Mattermost 的分支。一个完整的部署包含以下部分。只有前三项是必需的。

组件功能说明是否必需
Antimatter 服务器一个 Go 程序(antimatter),在 8065 端口提供 Web 应用、API 和 WebSocket 服务,运行内置应用(插件),并在 8443 端口承载通话媒体。命令行工具 amctl 用于管理它。是
PostgreSQL数据库:存储消息、用户、社区,以及在推荐配置中存储服务器配置。版本需为 15 或更高。是
文件存储上传的文件、图片和已安装的应用:使用 S3 兼容服务(compose 文件运行 RustFS)或本地目录。是
反向代理位于服务器前面的 HTTPS:使用 compose 文件的 Caddy 配置,或你自己的 nginx。生产环境必需
GIF 服务(gifs-server)为 GIF 选择器提供来自你自己目录的 GIF 和贴纸。它使用 Tenor API。否
推送代理通过 Apple 和 Google 将通知转发到移动应用。移动通知必需
rtcd、TURN 服务器用于大量通话的独立媒体服务器,以及为处于严格防火墙后的人员提供中继。否
AI 端点驱动撰写器重写、摘要、翻译、朗读、AI 智能体和通话转录的模型,以模型连接的形式添加:可以是云服务商,也可以是您自行运行的服务器。否

Antimatter 没有许可证限制,也没有付费版本:单点登录、LDAP、高可用性、合规性导出、数据保留以及 Mattermost 保留给付费计划的其他功能均已包含在内。

要求

  • 一台 Linux 服务器,amd64 或 arm64 架构,对于几百人的规模,至少需要 2 个 CPU 核心和 4 GB 内存,以及用于存储用户上传文件的磁盘空间。
  • 推荐安装方式使用带有 Compose 插件的 Docker Engine(docker compose)。如果使用软件包,则需要兼容 Debian、Ubuntu、Fedora 或 RHEL 且带有 systemd 的服务器。
  • 生产环境:一个指向服务器的域名,以及开放用于 HTTPS 的 80 和 443 端口。
  • 通话:端口 8443(UDP 和 TCP),需可被通话者访问。
  • 电子邮件:一个 Antimatter 可以发送邮件的 SMTP 服务器。

快速开始

mkdir antimatter && cd antimatter
curl -fsSLO https://antimatter.chat/compose.yaml
cat > .env <<EOF
SITE_URL=http://localhost:8065
POSTGRES_PASSWORD=$(openssl rand -hex 24)
S3_SECRET_KEY=$(openssl rand -hex 24)
GIFS_API_KEY=$(openssl rand -hex 24)
AM_AI_ENCRYPTION_KEY=$(openssl rand -base64 32)
EOF
docker compose up -d

然后打开站点 URL 并创建您的账户:第一个账户将成为系统管理员。安装 介绍了每个步骤以及其他安装方式。

本指南内容

  • 安装:Docker Compose、镜像、首位管理员、.deb 和 .rpm 软件包,以及发布存档。
  • 配置:数据库或文件中的设置、AM_ 环境变量、系统控制台、amctl、日志。
  • 域名和 HTTPS:站点 URL、Caddy、nginx、客户端地址。
  • 通话和语音:端口、NAT、TURN、rtcd、转录和实时字幕。
  • 电子邮件和推送:SMTP、推送代理和移动应用。
  • 内置应用:哪些应用已启用、它们的设置、安装其他应用。
  • AI:模型连接、内置 AI 功能、智能体、语音和翻译、加密密钥,以及数据流向何处。
  • 登录和账户:注册、密码、多因素认证、单点登录、LDAP、访客、会话。
  • 备份和升级:备份、恢复、升级、从 Mattermost 迁移。
  • 运维:监控、扩展、数据保留、合规性、故障排除。
  • 安全:加固清单和外部连接。
  • 桌面应用部署:MSI、组策略和 Intune、macOS 配置文件以及 Linux 策略文件。

您是在运营一个社区而不是服务器(频道、角色、审核)吗?请参阅运营社区。您正在构建集成吗?请参阅基于 Antimatter 构建。

您的第一个小时

  1. 安装并立即创建管理员账户。
  2. 将服务器置于其独立域名的 HTTPS 之后。
  3. 配置 SMTP 并发送一封测试邮件。
  4. 打开通话端口。对于企业,将新社区的类型设置为工作场所,以便在频道中启用通话。
  5. 决定谁可以注册,并启用多因素认证。
  6. 查看安全中的外部连接。
  7. 设置每日备份。在添加 AI 模型连接之前,请设置 AI 加密密钥。

获取帮助

请在社区讨论中提问,并在社区仓库中报告错误。请按照安全策略的说明,私下报告安全问题。