Project Icon

matrix-docker-ansible-deploy

Ansible和Docker 自动化部署Matrix服务器

matrix-docker-ansible-deploy是一个开源项目,用于快速部署自托管Matrix服务器。该项目利用Ansible实现自动化部署,通过Docker容器运行Synapse、Element等Matrix相关服务。项目集成了多种Matrix相关服务,如身份验证和媒体存储等。支持多种Linux发行版和架构,为用户提供灵活的部署选择,适合追求完全控制权的Matrix用户。

Matrix 支持室 捐赠

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

目的

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

也就是说,它允许您使用自己的 @<用户名>:<您的域名> 标识符加入 Matrix 网络,所有服务都托管在您自己的服务器上(参见前提条件)。

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

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

自托管或托管服务 / SaaS

这个 Ansible playbook 试图使自托管和维护 Matrix 服务器变得相当容易。尽管如此,顺利运行任何服务仍然需要知识、时间和精力。

如果您喜欢这个 Ansible playbook 的 FOSS 精神,但更愿意将责任交给其他人,您也可以从 etke.cc 获得托管的 Matrix 服务器(托管和本地部署) - 这是一个基于这个 Ansible playbook 构建的服务,但具有额外组件服务,它们都可以帮助您轻松运行 Matrix 服务器。请注意,etke.cc 采用基于订阅的方式运营,没有"只设置一次服务器就完事"的选项。

支持的服务

使用这个 playbook,您可以在服务器上配置以下服务列表。基本上,这个 playbook 旨在让您无需做任何其他事情就能启动并运行 Matrix 所需的所有必要组件。

注意:以下列表是详尽的。它包括一些可选或甚至高级组件,您很可能不需要这些组件。 坚持使用默认设置(安装上述组件的子集)是最佳选择,尤其是对于新安装。 您以后随时可以重新运行 playbook 来添加或删除组件。

家庭服务器

家庭服务器是您的 Matrix 系统的骨干。从以下列表中选择一个。

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

客户端

您可以在自己的域名上托管的 Matrix 网页客户端。

名称默认?描述文档
ElementWeb UI,默认配置为连接到您自己的 Synapse 服务器链接
Hydrogenx轻量级 Matrix 客户端,支持旧版和移动浏览器链接
Cinnyx简单、优雅和安全的网页客户端链接
SchildiChatx基于 Element,提供更传统的即时通讯体验链接

服务器组件

在服务器上运行以使安装的各个部分正常工作的服务。

名称默认?描述文档
PostgreSQLSynapse 的数据库。也可以使用外部 PostgreSQL 服务器链接
CoturnWebRTC 音频/视频通话的 STUN/TURN 服务器链接
TraefikWeb 服务器,监听 80、443 和 8448 端口 - 位于所有其他服务的前面。可以使用您自己的 Web 服务器链接
Let's Encrypt免费 SSL 证书,用于保护与所有组件的连接链接
ma1sdxMatrix 身份服务器链接
Exim邮件服务器,所有 Matrix 服务通过它发送出站电子邮件(可以配置为通过另一个 SMTP 服务器中继)链接
DimensionxMatrix 客户端的开源集成管理器链接
Sygnalx推送网关链接
ntfyx推送通知服务器链接

身份验证

扩展和修改用户在您的家庭服务器上的身份验证方式。

名称默认?描述文档
matrix-synapse-rest-auth(高级)xREST 身份验证密码提供程序模块链接
matrix-synapse-shared-secret-auth(高级)x密码提供程序模块链接
matrix-synapse-ldap3(高级)xLDAP 身份验证密码提供程序模块链接
matrix-ldap-registration-proxy(高级)x处理 Matrix 注册请求并将其转发到 LDAP 的代理链接
matrix-registrationx一个简单的 Python 应用程序,用于基于令牌的 Matrix 注册链接

文件存储

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

名称默认启用?描述文档
Goofysx用于 Synapse 内容存储库(media_store)文件的 Amazon S3(或其他兼容 S3 的对象存储)存储链接
synapse-s3-storage-providerx用于 Synapse 内容存储库(media_store)文件的 Amazon S3(或其他兼容 S3 的对象存储)存储链接
matrix-media-repoxmatrix-media-repo 是一个高度可定制的多域媒体存储库,专为 Matrix 设计。适用于中型到大型部署,这个媒体存储库在完全符合规范的同时对媒体进行去重。链接

桥接器

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

名称默认启用?描述文档
mautrix-discordx连接到 Discord 的桥接器链接
mautrix-slackx连接到 Slack 的桥接器链接
mautrix-telegramx连接到 Telegram 的桥接器链接
mautrix-gmessagesx连接到 Google Messages 的桥接器链接
mautrix-whatsappx连接到 WhatsApp 的桥接器链接
mautrix-facebookx连接到 Facebook 的桥接器链接
mautrix-twitterx连接到 Twitter 的桥接器链接
mautrix-hangoutsx连接到 Google Hangouts 的桥接器链接
mautrix-googlechatx连接到 Google Chat 的桥接器链接
mautrix-instagramx连接到 Instagram 的桥接器链接
mautrix-signalx连接到 Signal 的桥接器链接
beeper-linkedinx连接到 LinkedIn 的桥接器链接
matrix-appservice-ircx连接到 IRC 的桥接器链接
matrix-appservice-discordx连接到 Discord 的桥接器链接
matrix-appservice-slackx连接到 Slack 的桥接器链接
matrix-appservice-webhooksx用于兼容 Slack 的 webhook 的桥接器(ConcourseCISlack 等)链接
matrix-hookshotx用于通用 webhook 和多个项目管理服务的桥接器,特别是 GitHub、GitLab、Figma 和 Jira链接
matrix-sms-bridgex连接到 SMS 的桥接器链接
Heisenbridgex连接到 IRC 的跳板式桥接器链接
go-skype-bridgex连接到 Skype 的桥接器链接
mx-puppet-slackx连接到 Slack 的桥接器链接
mx-puppet-instagramx用于 Instagram 私信的桥接器(Instagram链接
mx-puppet-twitterx用于 Twitter 私信的桥接器(Twitter链接
mx-puppet-discordx连接到 Discord 的桥接器链接
mx-puppet-groupmex连接到 GroupMe 的桥接器链接
mx-puppet-steamx连接到 Steam 的桥接器链接
Email2Matrixx用于将电子邮件转发到 Matrix 房间的桥接器链接

机器人

机器人为您的安装提供各种额外功能。

名称默认?描述文档
matrix-reminder-botx用于安排一次性和重复提醒及闹钟的机器人链接
matrix-registration-botx通过创建和管理注册令牌进行邀请的机器人链接
maubotx基于插件的Matrix机器人系统链接
honoroitx帮助台机器人链接
Postmooglex电子邮件转Matrix机器人链接
Go-NEBx用Go编写的多功能机器人链接
MjolnirxMatrix的审核工具链接
DraupnirxMatrix的审核工具(Mjolnir的分支)链接
Buscarronx网页表单(HTTP POST)转Matrix链接
matrix-chatgpt-botx从Matrix访问ChatGPT链接

管理

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

名称默认?描述文档
synapse-adminx用于管理Matrix服务器上的用户和房间的Web UI工具链接
指标和图表x包括Prometheus时间序列数据库服务器、Prometheus node-exporter主机指标导出器和Grafana Web UI链接
Borgx备份链接
Rageshakex错误报告服务器链接
synapse-usage-exporterx导出Synapse主服务器的使用统计数据以供Prometheus抓取链接

其他

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

名称默认?描述文档
sliding-syncx为需要的客户端(如Element X)提供滑动同步支持链接
synapse_auto_accept_invitex自动接受邀请的Synapse模块链接
synapse_auto_compressorx在后台自动压缩state_groups数据库表的命令行工具链接
synapse-simple-antispam(高级)x垃圾信息检查模块链接
Matrix Corporal(高级)x托管Matrix服务器的协调器和网关链接
Etherpadx开源协作文本编辑器链接
Jitsix开源视频会议平台链接
Cactus Commentsx基于Matrix构建的联邦评论系统链接
Pantalaimonx支持端到端加密的代理守护进程链接

安装

要在您自己的服务器上配置和安装Matrix,请参阅docs/目录中的README

更改

该剧本随时间不断发展,有时会有不向后兼容的变更。

更新剧本时,请参阅更新日志了解新内容。

支持

相关

您可能还对mash-playbook感兴趣 - 另一个用于自托管非Matrix服务的Ansible剧本(查看其支持的服务列表)。

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

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

稿定AI

稿定设计 是一个多功能的在线设计和创意平台,提供广泛的设计工具和资源,以满足不同用户的需求。从专业的图形设计师到普通用户,无论是进行图片处理、智能抠图、H5页面制作还是视频剪辑,稿定设计都能提供简单、高效的解决方案。该平台以其用户友好的界面和强大的功能集合,帮助用户轻松实现创意设计。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号