From 72cf810e279ade46f785aeb7f9c4e5060d221c3f Mon Sep 17 00:00:00 2001 From: Letro Bot Date: Sat, 2 May 2026 13:14:51 +0330 Subject: [PATCH] edit readme --- README.md | 67 ++++++++++++++++++++++++------------------------------- 1 file changed, 29 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 6acc6f6eb..4044f1bd7 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,27 @@ -# Matrix Authentication Service +# Matrix Authentication Service (Letro Fork) -MAS (Matrix Authentication Service) is a user management and authentication service for [Matrix](https://matrix.org/) homeservers, written and maintained by [Element](https://element.io/). You can directly run and manage the source code in this repository, available under an AGPL license (or alternatively under a commercial license from Element). Support is not provided by Element unless you have a subscription. +> **This is a fork of [element-hq/matrix-authentication-service](https://github.com/element-hq/matrix-authentication-service)** +> Maintained by [Letro Tech GmbH](https://letro.com) -It has been created to support the migration of Matrix to a next-generation of auth APIs per [MSC3861](https://github.com/matrix-org/matrix-doc/pull/3861). +MAS (Matrix Authentication Service) is a user management and authentication service for [Matrix](https://matrix.org/) homeservers. This fork contains modifications and customizations specific to Letro's deployment needs. -See the [Documentation](https://element-hq.github.io/matrix-authentication-service/index.html) for information on installation and use. +For the official upstream documentation, see: [element-hq.github.io/matrix-authentication-service](https://element-hq.github.io/matrix-authentication-service/index.html) -You can learn more about Matrix and next-generation auth at [areweoidcyet.com](https://areweoidcyet.com/). +## 📋 About this Fork -## 🚀 Getting started +This repository is a fork of the upstream Matrix Authentication Service with customizations for Letro's infrastructure. -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. +**Upstream Repository**: [element-hq/matrix-authentication-service](https://github.com/element-hq/matrix-authentication-service) -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. +## 💬 Community -There are three editions of ESS: +For general Matrix Authentication Service discussion, join [#matrix-auth:matrix.org](https://matrix.to/#/#matrix-auth:matrix.org) -- [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 +## 🛠️ Installation -## 💬 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. - -## 🛠️ Standalone installation and configuration - -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). - -## 📖 Translations - -Matrix Authentication Service is available in multiple languages. -Anyone can contribute to translations through [Localazy](https://localazy.com/element-matrix-authentication-service/). - -## 🏗️ Contributing - -See the [contribution guidelines](https://element-hq.github.io/matrix-authentication-service/development/contributing.html) for information on how to contribute to this project. +For installation and configuration, refer to: +- **Upstream documentation**: [element-hq.github.io/matrix-authentication-service/setup](https://element-hq.github.io/matrix-authentication-service/setup/) +- Letro-specific deployment documentation (if applicable) ## ⚖️ Copyright & License @@ -57,5 +35,18 @@ This software is dual-licensed by Element Creations Ltd (Element). It can be use (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 -(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to). -Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses. +### Original Work +Copyright 2021-2024 The Matrix.org Foundation C.I.C. +Copyright 2024, 2025 New Vector Ltd. +Copyright 2025, 2026 Element Creations Ltd. + +### Modifications +Copyright 2026 Letro Tech GmbH + +This software is based on the Matrix Authentication Service and is licensed under the GNU Affero General Public License version 3 (AGPL-3.0). + +This program is free software: you can redistribute it and/or modify it 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. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License along with this program. If not, see \ No newline at end of file