Skip to content

Commit 2155c66

Browse files
committed
Update the README
1 parent af9765b commit 2155c66

File tree

2 files changed

+18
-23
lines changed

2 files changed

+18
-23
lines changed

README.md

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,29 @@
1-
# OAuth2.0 + OpenID Connect Provider for Matrix Homeservers
1+
# Matrix Authentication Service
22

3-
MAS (Matrix Authentication Service) is an OAuth 2.0 and OpenID Provider server for Matrix.
3+
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.
44

5-
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).
5+
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).
66

77
See the [Documentation](https://element-hq.github.io/matrix-authentication-service/index.html) for information on installation and use.
88

9-
You can learn more about Matrix and OIDC at [areweoidcyet.com](https://areweoidcyet.com/).
9+
You can learn more about Matrix and next-generation auth at [areweoidcyet.com](https://areweoidcyet.com/).
1010

11-
![Delegated OIDC architecture with MAS overview](overview.png)
11+
## 💬 Community room
1212

13-
## Features
13+
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.
1414

15-
- Supported homeservers
16-
- ✅ Synapse
17-
- Authentication methods:
18-
- ✅ Upstream OIDC
19-
- 🚧 Local password
20-
- ‼️ [Application Services login](https://element-hq.github.io/matrix-authentication-service/as-login.html) (**Encrypted bridges**)
21-
- Migration support
22-
- ✅ Compatibility layer for legacy Matrix authentication
23-
- ✅ Advisor on migration readiness
24-
- ✅ Import users from Synapse
25-
- ✅ Import password hashes from Synapse
26-
- ✅ Import of external subject IDs for upstream identity providers from Synapse
15+
## 🛠️ Installing and configuration
2716

28-
## Upstream Identity Providers
17+
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.
2918

30-
MAS is known to work with the following upstream IdPs via OIDC:
19+
The MAS documentation describes [how to install and configure MAS](https://element-hq.github.io/matrix-authentication-service/setup/).
20+
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).
3121

32-
- [Keycloak](https://www.keycloak.org/)
33-
- [Dex](https://dexidp.io/)
34-
- [Google](https://developers.google.com/identity/openid-connect/openid-connect)
22+
## 📖 Translations
23+
24+
Matrix Authentication Service is available in multiple languages.
25+
Anyone can contribute to translations through [Localazy](https://localazy.com/element-matrix-authentication-service/).
26+
27+
## 🏗️ Contributing
28+
29+
See the [contribution guidelines](https://element-hq.github.io/matrix-authentication-service/contributing.html) for information on how to contribute to this project.

overview.png

-470 KB
Binary file not shown.

0 commit comments

Comments
 (0)