From 0c0feab0c066db85aabff05dba552c2c1880d45a Mon Sep 17 00:00:00 2001 From: Max Dor Date: Wed, 19 Sep 2018 22:29:20 +0200 Subject: [PATCH] Improve docs --- docs/README.md | 3 +++ docs/faq.md | 2 +- docs/getting-started.md | 16 +++++++++++----- 3 files changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index ddc1139..a27c34e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,6 @@ # Table of Contents +- [Identity Concepts in Matrix](concepts.md) +- [Getting Started](getting-started.md) - [Build from sources](build.md) (Optional) - Installation - [Debian package](install/debian.md) @@ -20,3 +22,4 @@ - [SendGrid](threepids/notification/sendgrid-handler.md) - [Sessions](threepids/session/session.md) - [Views](threepids/session/session-views.md) +- [FAQ](faq.md) \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md index 328f58b..cb49c01 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -5,7 +5,7 @@ Identity in Matrix is one of the most difficult topic, mainly as it has not rece We have tried our best to put together documentation that requires almost no knowledge of Matrix inner workings to get a first basic setup running which relies on you reading the documentation in the right order: -- [The Concepts](concepts.md) in few words. +- [The Concepts](concepts.md) in few words. - [Getting Started](getting-started.md) step-by-step to a minimal working install. - [Identity stores](stores/README.md) you wish to fetch data from. - [Features](features) you are interested in that will use your Identity store(s) data. diff --git a/docs/getting-started.md b/docs/getting-started.md index a3fa6e8..037d18e 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -12,7 +12,7 @@ This will be a good ground work for further integration with features and your e ## Preparation You will need: -- Homeserver +- Working Homeserver, ideally with working federation - Reverse proxy with regular TLS/SSL certificate (Let's encrypt) for your mxisd domain As synapse requires an HTTPS connection when talking to an Identity service, **a reverse proxy is required** as mxisd does @@ -30,6 +30,7 @@ If you would like a high-level view of the infrastructure and how each feature i ## Install Install via: - [Debian package](install/debian.md) +- [ArchLinux](install/archlinux.md) - [Docker image](install/docker.md) - [Sources](build.md) @@ -118,10 +119,15 @@ It is recommended to remove `matrix.org` and `vector.im` (or any other default e your own Identity server is authoritative for your HS. ## Validate -Log in using your Matrix client and set `https://example.org` as your Identity server URL, replacing `example.org` by -the relevant hostname which you configured in your reverse proxy. -Invite `mxisd-federation-test@kamax.io` to a room, which should be turned into a Matrix invite to `@mxisd-lookup-test:kamax.io`. -At this point, the test user will join the room, send a congratulation message and leave. +**NOTE:** In case your homeserver has no working federation, step 5 will not happen. If step 4 took place, consider +your installation validated. + +1. Log in using your Matrix client and set `https://example.org` as your Identity server URL, replacing `example.org` by +the relevant hostname which you configured in your reverse proxy. +2. Create a new empty room. All further actions will take place in this room. +3. Invite `mxisd-federation-test@kamax.io` +4. The 3PID invite should be turned into a Matrix invite to `@mxisd-lookup-test:kamax.io`. +5. The invited test user will join the room, send a congratulation message and leave. **NOTE:** You might not see a suggestion for the e-mail address, which is normal. Still proceed with the invite. If it worked, it means you are up and running and can enjoy mxisd in its basic mode! Congratulations!