diff --git a/README.md b/README.md index c8b2cd8..01e8bd8 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,9 @@ to [sydent](https://github.com/matrix-org/sydent) and an external validation imp [Identity Service API](http://matrix.org/docs/spec/identity_service/unstable.html). # Scope -mxisd is a read-only Identity Server for corporate environments. -It provides a cascading lookup using LDAP then other identity servers, including the central Matrix servers. +mxisd is a federated Matrix Identity Server following a cascading lookup model, using LDAP then other identity servers, including the central Matrix servers. + +mxisd is currently read-only, implementation to bind 3PID will follow shortly. ## Contact If you need help, want to report a bug or just say hi, you can reach us at [#mxisd:kamax.io](https://matrix.to/#/#mxisd:kamax.io) @@ -18,15 +19,17 @@ For more high-level discussion about the Identity Server architecture/API, go to Default Lookup strategy will use a priority order and a configurable recursive/local type of request. ### E-mail -Given the 3PID `john.doe@example.org`, the following could be performed until a mapping is found: -- LDAP: lookup the Matrix ID (partial or complete) from a configurable attribute. +Given the 3PID `john.doe@example.org`, the following will be performed until a mapping is found: +- LDAP: lookup the Matrix ID (partial or complete) from a configurable attribute using a dedicated query. - DNS: lookup another Identity Server using the domain part of an e-mail and: - Look for a SRV record under `_matrix-identity._tcp.example.org` - Lookup using the base domain name `example.org` - Forwarder: Proxy the request to other configurable identity servers. ### Phone number -To be implemented once a formal spec is written by the Matrix people. +Given the phone number `+123456789`, the following lookup logic will be performed: +- LDAP: lookup the Matrix ID (partial or complete) from a configurable attribute using a dedicated query. +- Forwarder: Proxy the request to other configurable identity servers. # Quick start ## Requirements @@ -63,7 +66,8 @@ curl "http://localhost:8090/_matrix/identity/api/v1/lookup?medium=email&address= If you plan on testing the integration with a homeserver, you will need to run an HTTPS reverse proxy in front of it as the reference Home Server implementation [synapse](https://github.com/matrix-org/synapse) requires a HTTPS connection -to an ID server. +to an ID server. +See the [Integration section](https://github.com/kamax-io/mxisd#integration) for more details. # Install After [building](#build) the software, run all the following commands as `root` or using `sudo`