diff --git a/README.md b/README.md index 8bd75b2a9..23a3f3148 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,30 @@ See the [Documentation](https://element-hq.github.io/matrix-authentication-servi You can learn more about Matrix and next-generation auth at [areweoidcyet.com](https://areweoidcyet.com/). +## 🚀 Getting started + +This component is developed and maintained by [Element](https://element.io). It gets shipped as part of the **Element Server Suite (ESS)** which provides the official means of deployment. + +ESS is a Matrix distribution from Element with focus on quality and ease of use. It ships a full Matrix stack tailored to the respective use case. + +There are three editions of ESS: + +- [ESS Community](https://github.com/element-hq/ess-helm) - the free Matrix + distribution from Element tailored to small-/mid-scale, non-commercial + community use cases +- [ESS Pro](https://element.io/server-suite) - the commercial Matrix + distribution from Element for professional use +- [ESS TI-M](https://element.io/server-suite/ti-messenger) - a special version + of ESS Pro focused on the requirements of TI-Messenger Pro and ePA as + specified by the German National Digital Health Agency Gematik + ## 💬 Community room Developers and users of Matrix Authentication Service can chat in the [#matrix-auth:matrix.org](https://matrix.to/#/#matrix-auth:matrix.org) room on Matrix. -## 🛠️ Installing and configuration +## 🛠️ Standalone installation and configuration -The best way to get a modern Element Matrix stack is through the [Element Server Suite Community Edition](https://github.com/element-hq/ess-helm), which includes MAS. +The best way to get a modern Element Matrix stack is through the [Element Server Suite](https://element.io/en/server-suite), which includes MAS. The MAS documentation describes [how to install and configure MAS](https://element-hq.github.io/matrix-authentication-service/setup/). We recommend using the [Docker image](https://element-hq.github.io/matrix-authentication-service/setup/installation.html#using-the-docker-image) or the [pre-built binaries](https://element-hq.github.io/matrix-authentication-service/setup/installation.html#pre-built-binaries). @@ -30,10 +47,13 @@ See the [contribution guidelines](https://element-hq.github.io/matrix-authentica ## ⚖️ Copyright & License -Copyright 2024, 2025 New Vector Ltd. Copyright 2021-2024 The Matrix.org Foundation C.I.C. -This software is dual-licensed by New Vector Ltd (Element). It can be used either: +Copyright 2024, 2025 New Vector Ltd. + +Copyright 2025, 2026 Element Creations Ltd + +This software is dual-licensed by Element Creations Ltd (Element). It can be used either: (1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR