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

Clarify README

Browse Source
This commit is contained in:
Maxime Dor
2017-04-20 17:09:05 +02:00
parent be8e79f1d8
commit 70222aad83
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -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). [Identity Service API](http://matrix.org/docs/spec/identity_service/unstable.html).
# Scope # Scope
mxisd is a read-only Identity Server for corporate environments. mxisd is a federated Matrix Identity Server following a cascading lookup model, using LDAP then other identity servers, including the central Matrix servers.
It provides a cascading lookup using LDAP then other identity servers, including the central Matrix servers.
mxisd is currently read-only, implementation to bind 3PID will follow shortly.
## Contact ## 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) 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. Default Lookup strategy will use a priority order and a configurable recursive/local type of request.
### E-mail ### E-mail
Given the 3PID `john.doe@example.org`, the following could be performed until a mapping is found: 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. - 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: - 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` - Look for a SRV record under `_matrix-identity._tcp.example.org`
- Lookup using the base domain name `example.org` - Lookup using the base domain name `example.org`
- Forwarder: Proxy the request to other configurable identity servers. - Forwarder: Proxy the request to other configurable identity servers.
### Phone number ### 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 # Quick start
## Requirements ## Requirements
@@ -64,6 +67,7 @@ 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 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 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 # Install
After [building](#build) the software, run all the following commands as `root` or using `sudo` After [building](#build) the software, run all the following commands as `root` or using `sudo`