Web应用 活跃维护

matrix-docker-ansible-deploy

spantaleev/matrix-docker-ansible-deploy

🐳 使用 Ansible 和 Docker 设置 Matrix(用于安全去中心化通信的开放网络)服务器

6496
Stars 标星
1179
Forks 分支
91
Watchers 关注
8
Open Issues
Jinja
主要语言
AGPL-3.0
开源协议
24.9 MB
仓库大小
7 小时前
最后推送
一键安装扩展 / 插件指令
dsh plugin --profile web add github:spantaleev/matrix-docker-ansible-deploy
git clone https://github.com/spantaleev/matrix-docker-ansible-deploy.git
git clone git@github.com:spantaleev/matrix-docker-ansible-deploy.git
README.md master

英文原文正文为项目原始 README(英文),本站后续会翻译为中文,当前仅剔除图片与无关章节并统一排版。

使用 Ansible 和 Docker 搭建 Matrix(一个用于安全、去中心化通信的开放网络)服务器

🎯 目的

这个 Ansible 剧本旨在帮助你运行自己的 Matrix 家庭服务器,以及与之相关的 各种服务。

也就是说,它允许你使用自己的用户 ID(例如 @alice:example.com)加入 Matrix 网络,所有内容都托管在你自己的服务器上(参见 先决条件)。

我们在 Docker 容器中运行所有 支持的服务(参见 我们使用的容器镜像),这使我们能够在多个支持的发行版(参见 先决条件)和 架构(推荐 x86/amd64)上拥有可预测且最新的设置。

使用 Ansible 可以自动化安装(升级)和一些维护任务(参见 我们的 Ansible 指南)。

☁ 自主托管或托管 / SaaS

这个 Ansible 剧本试图让自托管和维护 Matrix 服务器变得相当容易(参见 快速入门)。不过,顺利运行任何服务仍然需要知识、时间和精力。

如果你喜欢这个 Ansible 剧本的 FOSS 精神,但更希望将责任交给他人,你也可以 通过 etke.cc 获取托管的 Matrix 服务器(包括托管和本地部署)——这是建立在这个 Ansible 剧本之上的服务,但带有 额外组件 和 服务,全部帮助你轻松运行 Matrix 服务器。请注意,etke.cc 采用基于订阅的方式运营,并没有“只需一次性设置服务器即可完成”的选项。

🚀 快速开始

我们在 docs/ 目录中有详细的文档——请参阅 文档 README 中的目录。

虽然 支持服务列表 和文档非常详尽,但您不需要全部阅读完。我们建议:

  • 从基础开始。您可以随时添加/删除或调整服务。

  • 按照我们的安装指南。有两个指南可供初学者和高级用户使用:

    • ⚡ 快速开始(适用于初学者):推荐给没有现有 Matrix 服务器并希望快速以“推荐默认设置”开始的人。

    • 完整安装指南(适用于高级用户):如果您需要将现有 Matrix 服务器的数据导入新服务器,或希望在设置服务器时了解更多内容,请从 先决条件 文档页面开始。

如果您在配置剧本、设置服务器、维护服务等方面遇到问题,请查看我们的 常见问题。如果找不到问题的答案,请随时寻求 帮助与支持。

✔ 支持的服务

使用这个剧本,您可以获得在服务器上配置的以下服务列表。基本上,这个剧本旨在让您快速运行Matrix所需的一切,而无需您做其他操作。

注意事项:

  • 下面的列表是详尽的。它包括可选的,甚至一些高级组件,而您很可能不需要。对于新安装而言,坚持默认设置(安装上述组件的一个子集)是最佳选择。您之后也可以随时重新运行剧本以添加或移除组件。

  • 已弃用或不再维护的服务未列出。您可以在此处找到它们的文档 here。

Homeserver(主服务器)

Homeserver 是您 Matrix 系统的骨干。请从以下列表中选择一个。

名称 默认? 描述 文档
Synapse ✅ 在 Matrix 网络中存储您的数据并管理您的存在 链接
Conduit ❌ 在 Matrix 网络中存储您的数据并管理您的存在。Conduit 是一个轻量级开源服务器实现 Matrix 规范,重点是易于设置和低系统需求 链接
continuwuity ❌ 在 Matrix 网络中存储您的数据并管理您的存在。 链接
Tuwunel ❌ 在 Matrix 网络中存储您的数据并管理您的存在。Tuwunel 是 conduwuit 的官方继任者。 链接
Dendrite ❌ 在 Matrix 网络中存储您的数据并管理您的存在。Dendrite 是用 Go 编写的第二代 Matrix 家庭服务器,是 Synapse 的替代方案。 链接

客户端

适用于 Matrix 的 Web 客户端,您可以在自己的域名上托管。

名称 默认? 描述 文档
Element Web ✅ 默认的 Matrix 网络客户端,配置为连接到您自己的 Synapse 服务器 链接
Hydrogen ❌ 轻量级 Matrix 客户端,支持传统和移动浏览器 链接
Cinny ❌ 简单、优雅且安全的网络客户端 链接
Sable ❌ 简单、优雅且安全的网络客户端 链接
SchildiChat Web ❌ 基于 Element Web,提供更传统的即时通讯体验 链接
FluffyChat Web ❌ Matrix 中最可爱的通讯软件 链接
Commet ❌ Matrix 网络客户端 链接

服务器组件

在服务器上运行的服务,用于使您的安装各部分正常工作。

名称 默认? 描述 文档
PostgreSQL ✅ Synapse 的数据库。也可以 使用外部 PostgreSQL 服务器。 链接
Traefik ✅ Web 服务器,监听端口 80、443 和 8448 —— 位于所有其他服务前面。也可以 使用您自己的 Web 服务器。 链接
Let's Encrypt ✅ 免费 SSL 证书,用于保护所有组件的连接 链接
Exim ✅ 邮件服务器,通过它所有 Matrix 服务发送外发邮件(可以配置通过其他 SMTP 服务器中继) 链接
coturn ❌ WebRTC 音视频通话的 STUN/TURN 服务器 链接
ddclient ❌ 动态 DNS 链接
Matrix RTC 栈 ❌ 支持 Matrix 客户端应用内音视频通话的组件 (LiveKit 服务器 和 LiveKit JWT 服务) 链接

认证

扩展和修改用户在您的 homeserver 上的认证方式。

名称 默认? 描述 文档
matrix-synapse-rest-auth(高级) ❌ REST认证密码提供模块 链接
matrix-synapse-shared-secret-auth(高级) ❌ 密码提供模块 链接
matrix-synapse-ldap3(高级) ❌ LDAP认证密码提供模块 链接
Matrix 用户验证服务 ❌ 基于 Open ID 令牌验证用户详细信息的服务 链接
synapse-simple-antispam(高级) ❌ 垃圾邮件检查模块 链接

文件存储

使用默认 media_store 文件夹以外的替代文件存储。

名称 默认? 描述 文档
Goofys ❌ 用于 Synapse 内容存储库 (media_store) 文件的 Amazon S3(或其他兼容 S3 的对象存储) 链接
synapse-s3-storage-provider ❌ 用于 Synapse 内容存储库 (media_store) 文件的 Amazon S3(或其他兼容 S3 的对象存储) 链接
matrix-media-repo ❌ 面向 Matrix 的高度可定制的多域媒体存储库。适用于中到大型部署,该媒体存储库在完全符合规范的同时进行媒体去重。 链接

桥接(Bridges)

桥接可以用于将您的 Matrix 安装与第三方通信网络连接。

名称 默认? 描述 文档
mautrix-discord ❌ 桥接到 Discord 链接
mautrix-slack ❌ 桥接到 Slack 链接
mautrix-telegram ❌ 桥接到 Telegram 链接
mautrix-gmessages ❌ 桥接到 Google Messages 链接
mautrix-gvoice ❌ 桥接到 Google Voice 链接
mautrix-linkedin ❌ 桥接到 LinkedIn 链接
mautrix-whatsapp ❌ 桥接到 WhatsApp 链接
mautrix-wsproxy ❌ 桥接到 Android 短信或 Apple iMessage 链接
matrix-rustpush-bridge ❌ 通过 Apple 推送通知服务桥接到 iMessage 链接
mautrix-bluesky ❌ 桥接到 Bluesky 链接
mautrix-twitter ❌ 桥接到 Twitter 链接
mautrix-googlechat ❌ 通向 Google Chat 的桥接 链接
mautrix-meta ❌ 通向 Messenger 和 Instagram 的桥接 Messenger 链接 / Instagram 链接
mautrix-signal ❌ 通向 Signal 的桥接 链接
beeper-line ❌ 通向 LINE 的桥接 链接
matrix-appservice-irc ❌ 通向 IRC 的桥接 链接
matrix-appservice-discord ❌ 通向 Discord 的桥接 链接
matrix-hookshot ❌ 通用 webhooks 桥接以及多项目管理服务桥接,特别是 GitHub、GitLab、Figma 和 Jira 链接
matrix-sms-bridge ❌ 通向 SMS 的桥接 链接
matrix-steam-bridge ❌ 通向 Steam 的桥接 链接
matrix-wechat ❌ 通向 WeChat 的桥接 链接
Heisenbridge ❌ Bouncer 风格的桥接到 IRC 链接
meshtastic-matrix-relay ❌ 桥接到 Meshtastic 网格网络 链接
mx-puppet-groupme ❌ 桥接到 GroupMe 链接
mx-puppet-steam ❌ 桥接到 Steam 链接
Postmoogle ❌ Email 到 Matrix 的桥接 链接

机器人

机器人为您的安装提供各种附加功能。

名称 默认? 描述 文档
baibot ❌ 向您展示 AI / 大型语言模型 的强大功能的机器人 链接
matrix-reminder-bot ❌ 用于安排一次性和循环提醒及闹钟的机器人 链接
maubot ❌ 基于插件的 Matrix 机器人系统 链接
Honoroit ❌ 帮助台机器人 链接
Mjolnir ❌ 用于 Matrix 的管理工具 链接
Draupnir ❌ 用于 Matrix 的管理工具(Mjolnir 的分支) 链接 (用于 应用服务模式)
Meowlnir ❌ 用于 Matrix 的管理工具,在应用服务模式下运行 链接
Buscarron ❌ 将 Web 表单(HTTP POST)发送到 Matrix 链接

管理

帮助您管理和监控 Matrix 安装的服务。

名称 默认? 描述 文档
matrix-alertmanager-receiver ❌ Prometheus 的 Alertmanager 客户端 链接
Matrix Authentication Service ❌ OAuth 2.0 和 OpenID 提供者服务器 链接
Ketesa ❌ 用于管理您的 Matrix homeserver 的全功能网页界面 — 用户、房间、媒体、会话等 链接
指标和图表 ❌ 包含 Prometheus 时间序列数据库服务器、Prometheus node-exporter 主机指标导出器以及 Grafana 网页 UI,同时也可使用 prometheus-nginxlog-exporter 链接 (针对 prometheus-nginxlog-exporter)
Borg ❌ 备份 链接
rageshake ❌ 错误报告服务器 链接
synapse-usage-exporter ❌ 导出 Synapse homeserver 的使用统计数据,以供 Prometheus 抓取。 链接

其他

各种不属于其他类别的服务。

名称 默认? 描述 文档
synapse_auto_compressor ❌ 一款可以在后台自动压缩 state_groups 数据库表的命令行工具 链接
Matrix Corporal (高级) ❌ 用于管理 Matrix 服务器的调解器和网关 链接
Matrix.to ❌ 用于 Matrix 生态系统的简单 URL 重定向服务 链接
Etherpad ❌ 开源协作文本编辑器 链接
Jitsi ❌ 开源视频会议平台 链接
Cactus Comments ❌ 基于 Matrix 的联合评论系统 链接
Pantalaimon ❌ 支持端到端加密(E2EE)的代理守护进程 链接
Sygnal ❌ 推送网关 链接
ntfy ❌ 推送通知服务器 链接
Element Call ❌ 原生 Matrix 视频会议应用 链接

🆕 变更

这个操作手册会随着时间发展,有时会包含不向后兼容的更改。

在更新操作手册时,请参考 更新日志 以了解最新内容。

🆘 支持

🌐 翻译

有关翻译的更多信息,请参阅 i18n/README.md 文件。

翻译仍在进行中。

🤝 相关

你可能也会对 mash-playbook 感兴趣——这是另一个用于自托管非 Matrix 服务的 Ansible 剧本(请参阅其 支持的服务列表)。

mash-playbook 还使用 Traefik 作为反向代理,因此通过一些小的 互操作性调整,你可以让 matrix-docker-ansible-deploy 和 mash-playbook 共存,在同一台服务器上托管 Matrix 和非 Matrix 服务。

本站来源与版权声明
  • 本文标题:matrix-docker-ansible-deploy - 🐳 使用 Ansible 和 Docker 设置 M
  • 本文链接:https://www.cn121.com/webapp/spantaleev-matrix-docker-ansible-deploy.html
  • 原项目:spantaleev/matrix-docker-ansible-deploy 版权归原作者 spantaleev 及贡献者所有
  • 收录信息:本站于 2026-10-10 收录本项目,本页所列协议与仓库指标均为收录当时的状态;该日期之后原项目的版本更新与协议变更,本页不作同步。
  • 开源协议:收录时本项目采用 AGPL-3.0(查看 LICENSE 原文),本站转载其原始文档(未改动文字,仅剔除图片与无关章节);使用、修改、分发请以该仓库 LICENSE 原文为准。基于本页内容形成的衍生作品, 须同样以该协议发布。
  • 站点出处:本文首发于 OneTwoOne,收录自 GitHub 开源项目 spantaleev/matrix-docker-ansible-deploy。
  • 内容说明:本页正文为原项目 README 原文(英文),本站后续会翻译为中文(当前尚未译出,仅将二级标题译为中文,便于按栏目定位;标题原文可在下方原仓库中查看),仅剔除了图片与赞助等无关章节、并把相对链接改为绝对地址;页首简介为机器翻译自仓库描述。
  • 引用声明:商业转载、第三方聚合或 AI 检索训练引用时,请务必保留以上来源出处、本文永久链接,以及原项目的版权声明与许可信息。
  • 下架通道:若原项目此后变更或收紧了许可协议、或作者/权利人认为本站的收录方式(译文、排版适配、简介翻译等)超出其授权范围,请通过 xyd3302001@163.com 发送下架通知,并附上项目地址与本页链接。本站核实后将第一时间删除本页内容,或改为不复制原文的目录性收录;署名更正等其他要求可一并提出。