Skip to content

Latest commit

 

History

History
155 lines (124 loc) · 6.41 KB

getting-started.md

File metadata and controls

155 lines (124 loc) · 6.41 KB
Raw

Getting started

  1. Preparation
  2. Install
  3. Configure
  4. Integrate
  5. Validate
  6. Next steps

Following these quick start instructions, you will have a basic setup that can perform recursive/federated lookups.
This will be a good ground work for further integration with features and your existing Identity stores.

If you would like a more fully integrated setup out of the box, the matrix-docker-ansible-deploy project provides a turn-key full-stack solution, including LDAP and the various ma1sd features enabled and ready.
We work closely with the project owner so the latest ma1sd version is always supported.

If you choose to use it, this Getting Started guide is not applicable - See the project documentation. You may then directly go to the Next steps.

Preparation

You will need:

  • Working Homeserver, ideally with working federation
  • Reverse proxy with regular TLS/SSL certificate (Let's encrypt) for your ma1sd domain

If you use synapse:

  • It requires an HTTPS connection when talking to an Identity service, a reverse proxy is required as ma1sd does not support HTTPS listener at this time.
  • HTTPS is hardcoded when talking to the Identity server. If your Identity server URL in your client is https://matrix.example.org/, then you need to ensure https://matrix.example.org/_matrix/identity/api/v1/... will reach ma1sd if called from the synapse host. In doubt, test with curl or similar.

For maximum integration, it is best to have your Homeserver and ma1sd reachable via the same public hostname.

Be aware of a NAT/Reverse proxy gotcha if you use the same host.

The following Quick Start guide assumes you will host the Homeserver and ma1sd under the same hostname.
If you would like a high-level view of the infrastructure and how each feature is integrated, see the dedicated document

Install

Install via:

See the Latest release for links to each.

Configure

NOTE: Please view the install instruction for your platform, as this step might be optional or already handled for you.

NOTE: Details about configuration syntax and format are described here

If you haven't created a configuration file yet, copy ma1sd.example.yaml to where the configuration file is stored given your installation method and edit to your needs.

The following items must be at least configured:

  • matrix.domain should be set to your Homeserver domain (server_name in synapse configuration)
  • key.path will store the signing keys, which must be kept safe! If the file does not exist, keys will be generated for you.
  • storage.provider.sqlite.database is the location of the SQLite Database file which will hold state (invites, etc.)

If your HS/ma1sd hostname is not the same as your Matrix domain, configure server.name.
Complete configuration guide is available here.

Integrate

For an overview of a typical ma1sd infrastructure, see the dedicated document

Reverse proxy

Apache2

In the VirtualHost section handling the domain with SSL, add the following and replace 0.0.0.0 by the internal hostname/IP pointing to ma1sd.
This line MUST be present before the one for the homeserver!

ProxyPass /_matrix/identity http://0.0.0.0:8090/_matrix/identity

Typical configuration would look like:

<VirtualHost *:443>
    ServerName matrix.example.org
    
    # ...
    
    ProxyPreserveHost on
    ProxyPass /_matrix/identity http://localhost:8090/_matrix/identity
    ProxyPass /_matrix http://localhost:8008/_matrix
</VirtualHost>

nginx

In the server section handling the domain with SSL, add the following and replace 0.0.0.0 with the internal hostname/IP pointing to ma1sd. This line MUST be present before the one for the homeserver!

location /_matrix/identity {
    proxy_pass http://0.0.0.0:8090/_matrix/identity;
}

Typical configuration would look like:

server {
    listen 443 ssl;
    server_name matrix.example.org;
    
    # ...
    
    location /_matrix/identity {
        proxy_pass http://localhost:8090/_matrix/identity;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $remote_addr;
    }
    
    location /_matrix {
        proxy_pass http://localhost:8008/_matrix;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $remote_addr;
    }
}

Synapse (Deprecated with synapse v1.4.0)

Add your ma1sd domain into the homeserver.yaml at trusted_third_party_id_servers and restart synapse.
In a typical configuration, you would end up with something similar to:

trusted_third_party_id_servers:
    - matrix.example.org

Validate (Under reconstruction)

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://matrix.example.org as your Identity server URL, replacing matrix.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 [email protected]
  4. The 3PID invite should be turned into a Matrix invite to @ma1sd-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 ma1sd in its basic mode! Congratulations!
If it did not work, read the basic troubleshooting guide, get in touch and we'll do our best to get you started.

Next steps

Once your ma1sd server is up and running, there are several ways you can enhance and integrate further with your infrastructure: