cqrenet/mxids
3
0
Fork 0
Code Pull Requests 10 Actions Releases Activity

Link to targeted setups in main README

Browse Source
This commit is contained in:
Max Dor
2019-02-06 04:01:13 +01:00
parent 67bc18af7d
commit 8d6850d346
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -20,7 +20,8 @@ It is the one stop shop for anything regarding Authentication, Directory and Ide
single coherent product. single coherent product.
mxisd is specifically designed to connect to an existing on-premise Identity store (AD/Samba/LDAP, SQL Database, mxisd is specifically designed to connect to an existing on-premise Identity store (AD/Samba/LDAP, SQL Database,
Web services/app, etc.) and ease the integration of a Matrix infrastructure within an existing one. Web services/app, etc.) and ease the integration of a Matrix infrastructure within an existing one.
Check [our FAQ entry](docs/faq.md#what-kind-of-setup-is-mxisd-really-designed-for) to know if mxisd is a good fit for you.
The core principle of mxisd is to map between Matrix IDs and 3PIDs (Third-Party IDentifiers) for the Homeserver and its The core principle of mxisd is to map between Matrix IDs and 3PIDs (Third-Party IDentifiers) for the Homeserver and its
users. 3PIDs can be anything that uniquely and globally identify a user, like: users. 3PIDs can be anything that uniquely and globally identify a user, like:
@@ -67,6 +68,8 @@ As an enhanced Identity service:
- Users can directly find each other using whatever attribute is relevant within your Identity store - Users can directly find each other using whatever attribute is relevant within your Identity store
- Federate your Identity server so you can discover others and/or others can discover you - Federate your Identity server so you can discover others and/or others can discover you
Also, check [our FAQ entry](docs/faq.md#what-kind-of-setup-is-mxisd-really-designed-for) to know if mxisd is a good fit for you.
# Getting started # Getting started
See the [dedicated document](docs/getting-started.md) See the [dedicated document](docs/getting-started.md)

8
docs/faq.md
View File

@@ -18,10 +18,10 @@ started and answer questions you might have.
### What kind of setup is mxisd really designed for? ### What kind of setup is mxisd really designed for?
mxisd is primarily designed for setups that: mxisd is primarily designed for setups that:
- Care for their privacy - [Care for their privacy](https://github.com/kamax-matrix/mxisd/wiki/mxisd-and-your-privacy)
- Have their own domains - Have their own [domains](https://en.wikipedia.org/wiki/Domain_name)
- Use that domain for their email addresses and all other services - Use those domains for their email addresses and all other services
- Already have an Identity store, typically LDAP-based. - Already have an [Identity store](stores/README.md), typically [LDAP-based](stores/ldap.md).
If you meet all the conditions, then you are the prime use case we designed mxisd for. If you meet all the conditions, then you are the prime use case we designed mxisd for.