.. image:: https://github.com/element-hq/synapse/raw/develop/docs/element_logo_white_bg.svg :height: 60px

Element Synapse - Matrix 家庭服务器实现

Synapse 是一个开源的 Matrix <https://matrix.org>__ 家庭服务器实现，由 Element <https://element.io>_ 编写和维护。 Matrix <https://github.com/matrix-org>__ 是用于安全且可互操作的实时通信的开放标准。您可以直接运行和管理此仓库中的源代码，该代码在 AGPL 许可证下提供（或者也可以选择 Element 的商业许可证）。

除非您拥有来自 Element 的订阅，否则 Element 不提供任何支持。

🚀 快速入门

此组件由 Element <https://element.io>_ 开发和维护。它作为 Element Server Suite (ESS) 的一部分发布，提供了官方的部署方式。

ESS 是 Element 提供的 Matrix 发行版，专注于质量和易用性。它提供了一个针对特定用例定制的完整 Matrix 技术栈。

ESS 有三个版本：

ESS Community <https://github.com/element-hq/ess-helm>_ - Element 提供的免费 Matrix 发行版，专为小型/中型、非商业社区用例定制
ESS Pro <https://element.io/server-suite>_ - Element 提供的商业 Matrix 发行版，用于专业用途
ESS TI-M <https://element.io/server-suite/ti-messenger>_ - ESS Pro 的一个特殊版本专注于德国国家数字健康机构 Gematik 规定的 TI-Messenger Pro 和 ePA 的需求

🛠️ 独立安装和配置

Synapse 文档介绍了 单独安装 Synapse 的选项 <https://element-hq.github.io/synapse/latest/setup/installation.html>_。有关更多有用的文档链接，请参见下文。

Synapse configuration options <https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html>_
Synapse configuration for federation <https://element-hq.github.io/synapse/latest/federate.html>_
Using a reverse proxy with Synapse <https://element-hq.github.io/synapse/latest/reverse_proxy.html>_
Upgrading Synapse <https://element-hq.github.io/synapse/develop/upgrade.html>_

🎯 故障排除与支持

🚀 专业支持

Synapse 的企业级支持（包括 SLA）包含在 Element Server Suite (ESS) <https://element.io/pricing>_ 订阅中。

如果您是现有的 ESS 订阅者，您可以提交 support request <https://ems.element.io/support>_ 并访问 Element product documentation <https://docs.element.io>_。

🤝 社区支持

Admin FAQ <https://element-hq.github.io/synapse/latest/usage/administration/admin_faq.html>_ 包含处理一些常见问题的技巧。更多详情，请参阅 Synapse's wider documentation <https://element-hq.github.io/synapse/latest/>_。

如需有关安装或管理 Synapse 的额外支持，请在社区支持房间 |room|_ 中提问（如有必要，请使用 matrix.org 账户）。我们不会使用 GitHub issue 来处理支持请求，仅用于 bug 报告和功能请求。

.. |room| replace:: #synapse:matrix.org .. _room: https://matrix.to/#/#synapse:matrix.org

.. |docs| replace:: docs .. _docs: docs

🛠️ 开发

我们欢迎社区对 Synapse 的贡献！最好的入门途径是我们的 guide for contributors <https://element-hq.github.io/synapse/latest/development/contributing_guide.html>。这是我们更广泛的 documentation <https://element-hq.github.io/synapse/latest> 的一部分，其中包含面向 Synapse 开发者和 Synapse 管理员的信息。

开发者可能特别感兴趣的是：

Synapse's database schema <https://element-hq.github.io/synapse/latest/development/database_schema.html>_,
notes on Synapse's implementation details <https://element-hq.github.io/synapse/latest/development/internal_documentation/index.html>_, 以及
how we use git <https://element-hq.github.io/synapse/latest/development/git.html>_.

除此之外，请加入我们在 Matrix 上的开发者社区： #synapse-dev:matrix.org <https://matrix.to/#/#synapse-dev:matrix.org>_，这里有真实的人类！

Copyright and Licensing

本软件由 Element Creations Ltd (Element) 双重授权。它可以：

(1) 根据 GNU Affero General Public License（由 Free Software Foundation 发布，许可证版本 3 或（在您选择下）任何更高版本）的条款免费使用；或

(2) 根据您与 Element 之间付费的 Element Commercial License 协议的条款使用（其条款可能因您与 Element 达成的协议而异）。

除非适用法律要求或书面协议另有规定，根据许可证分发的软件按“原样”提供，不附带任何明示或暗示的保证或条件。请参阅许可证中关于许可证下权限和限制的具体语言。

请联系 licensing@element.io <mailto:licensing@element.io>_ 购买本软件的 Element 商业许可证。

.. |support| image:: https://img.shields.io/badge/matrix-community%20support-success :alt: (get community support in #synapse:matrix.org) :target: https://matrix.to/#/#synapse:matrix.org

.. |development| image:: https://img.shields.io/matrix/synapse-dev:matrix.org?label=development&logo=matrix :alt: (discuss development on #synapse-dev:matrix.org) :target: https://matrix.to/#/#synapse-dev:matrix.org

.. |documentation| image:: https://img.shields.io/badge/documentation-%E2%9C%93-success :alt: (Rendered documentation on GitHub Pages) :target: https://element-hq.github.io/synapse/latest/

.. |license| image:: https://img.shields.io/github/license/element-hq/synapse :alt: (在 LICENSE 文件中查看许可证) :target: LICENSE

.. |pypi| image:: https://img.shields.io/pypi/v/matrix-synapse :alt: (PyPi 上发布的最新版本) :target: https://pypi.org/project/matrix-synapse

.. |python| image:: https://img.shields.io/pypi/pyversions/matrix-synapse :alt: (支持的 Python 版本) :target: https://pypi.org/project/matrix-synapse