NO LONGER MAINTAINED / ABANDONED
mxisd is a Federated Matrix Identity server for self-hosted Matrix infrastructures with enhanced features.
It is specifically designed to connect to an Identity store (AD/Samba/LDAP, SQL Database, Web services/application, ...) and ease the integration of the Matrix ecosystem with an existing infrastructure, or to build a new one using lasting tools.
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 identify a user, like:
- Full name
- Email address
- Phone number
- Employee number
- Skype/Live ID
- Twitter handle
- Facebook ID
- ...
mxisd is an enhanced Identity service, which implements the Matrix Identity service API but also several other features that greatly enhance user experience within Matrix.
mxisd is the one stop shop for anything regarding Authentication, Directory and Identity management in Matrix built as a single coherent product.
As a regular Matrix Identity service:
- Search for people by 3PID using its own Identity stores (LDAP, SQL, etc.)
- Invite people to rooms by 3PID using its own Identity stores, with notifications to the invitee (Email, SMS, etc.)
- Allow users to add 3PIDs to their settings/profile
As an enhanced Identity service:
- Use a recursive lookup mechanism when searching and inviting people by 3PID, allowing to fetch data from:
- Own Identity store
- Federated Identity servers, if applicable to the 3PID
- Arbitrary Identity servers
- Central Matrix Identity servers
- Extensive control of where 3PIDs are transmited, so they are not leaked publicly by users
- Authentication support for synapse via the REST auth module
- Directory integration which allows you to search for users within your organisation, even without prior Matrix contact
- Auto-fill of user profile (Display name, 3PIDs) via the REST auth module
- Use your existing Identity store, do not duplicate information
- Auto-fill user profiles with relevant information
- As an organisation, stay in control of 3PIDs so they are not published to the central Matrix.org servers where they currently cannot be removed
- Users can directly find each other using whatever attribute is relevant within your Identity store
- Federate your Identity lookups so you can discover others and/or others can discover you, all with extensive ACLs
See the dedicated document
If you need help, want to report a bug or just say hi, you can reach us on Matrix at #mxisd:kamax.io or directly peek anonymously. For more high-level discussion about the Identity Server architecture/API, go to #matrix-identity:matrix.org
If you would prefer professional support/custom development for mxisd and/or for Matrix in general, including other open source technologies/products, please visit our website to get in touch with us and get a quote.
We offer affordable monthly/yearly support plans for mxisd, synapse or your full Matrix infrastructure.
First and foremost, the best way to contribute is to use mxisd and tell us about it!
We would love to hear about your experience and get your feedback on how to make it an awesome product.
You can contribute as a community member by:
- Opening issues for any weird behaviour or bug. mxisd should feel natural, let us know if it does not!
- Helping us improve the documentation: tell us what is good or not good (in an issue or in Matrix), or make a PR with changes you feel improve the doc.
- Contribute code directly: we love contributors! All your contributions will be licensed under AGPLv3.
- Donate! Any donation is welcome, regardless how small or big, and will directly be used for the fixed costs and developer time of mxisd.
You can contribute as an organisation/corporation by:
- Get a support contract. This is the best way you can help us as it ensures mxisd is maintained regularly and you get direct access to the support team.
- Sponsoring new features or bug fixes. Get in touch so we can discuss it further.
See the dedicated document
Get in touch via:
- Matrix at #mxisd:kamax.io
- Email, see our website: Kamax.io