From 8d6850d346b058d369f18c0a6eed260ac85ced65 Mon Sep 17 00:00:00 2001 From: Max Dor Date: Wed, 6 Feb 2019 04:01:13 +0100 Subject: [PATCH] Link to targeted setups in main README --- README.md | 5 ++++- docs/faq.md | 8 ++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8ecdcfb..5e7ce9a 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,8 @@ It is the one stop shop for anything regarding Authentication, Directory and Ide single coherent product. 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 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 - 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 See the [dedicated document](docs/getting-started.md) diff --git a/docs/faq.md b/docs/faq.md index 5cdd9ad..5b26b3d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -18,10 +18,10 @@ started and answer questions you might have. ### What kind of setup is mxisd really designed for? mxisd is primarily designed for setups that: -- Care for their privacy -- Have their own domains -- Use that domain for their email addresses and all other services -- Already have an Identity store, typically LDAP-based. +- [Care for their privacy](https://github.com/kamax-matrix/mxisd/wiki/mxisd-and-your-privacy) +- Have their own [domains](https://en.wikipedia.org/wiki/Domain_name) +- Use those domains for their email addresses and all other services +- 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.