Update the README
This commit is contained in:
41
README.md
41
README.md
@@ -1,34 +1,29 @@
|
||||
# OAuth2.0 + OpenID Connect Provider for Matrix Homeservers
|
||||
# Matrix Authentication Service
|
||||
|
||||
MAS (Matrix Authentication Service) is an OAuth 2.0 and OpenID Provider server for Matrix.
|
||||
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.
|
||||
|
||||
It has been created to support the migration of Matrix to an OpenID Connect (OIDC) based authentication layer as per [MSC3861](https://github.com/matrix-org/matrix-doc/pull/3861).
|
||||
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).
|
||||
|
||||
See the [Documentation](https://element-hq.github.io/matrix-authentication-service/index.html) for information on installation and use.
|
||||
|
||||
You can learn more about Matrix and OIDC at [areweoidcyet.com](https://areweoidcyet.com/).
|
||||
You can learn more about Matrix and next-generation auth at [areweoidcyet.com](https://areweoidcyet.com/).
|
||||
|
||||

|
||||
## 💬 Community room
|
||||
|
||||
## Features
|
||||
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.
|
||||
|
||||
- Supported homeservers
|
||||
- ✅ Synapse
|
||||
- Authentication methods:
|
||||
- ✅ Upstream OIDC
|
||||
- 🚧 Local password
|
||||
- ‼️ [Application Services login](https://element-hq.github.io/matrix-authentication-service/as-login.html) (**Encrypted bridges**)
|
||||
- Migration support
|
||||
- ✅ Compatibility layer for legacy Matrix authentication
|
||||
- ✅ Advisor on migration readiness
|
||||
- ✅ Import users from Synapse
|
||||
- ✅ Import password hashes from Synapse
|
||||
- ✅ Import of external subject IDs for upstream identity providers from Synapse
|
||||
## 🛠️ Installing and configuration
|
||||
|
||||
## Upstream Identity Providers
|
||||
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.
|
||||
|
||||
MAS is known to work with the following upstream IdPs via OIDC:
|
||||
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).
|
||||
|
||||
- [Keycloak](https://www.keycloak.org/)
|
||||
- [Dex](https://dexidp.io/)
|
||||
- [Google](https://developers.google.com/identity/openid-connect/openid-connect)
|
||||
## 📖 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/contributing.html) for information on how to contribute to this project.
|
||||
|
||||
BIN
overview.png
BIN
overview.png
Binary file not shown.
|
Before Width: | Height: | Size: 470 KiB |
Reference in New Issue
Block a user