README.rst 18.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
.. contents::


Matrix is an ambitious new ecosystem for open federated Instant Messaging and
VoIP.  The basics you need to know to get up and running are:

- Everything in Matrix happens in a room.  Rooms are distributed and do not
  exist on any single server.  Rooms can be located using convenience aliases
  like ```` or ``#test:localhost:8448``.

- Matrix user IDs look like ```` (although in the future
  you will normally refer to yourself and others using a third party identifier
  (3PID): email address, phone number, etc rather than manipulating Matrix user IDs)
16 17 18 19 20 21 22

The overall architecture is::

      client <----> homeserver <=====================> homeserver <----> client

```` is the official support room for Matrix, and can be
accessed by any client from or
via IRC bridge at irc://
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

Synapse is currently in rapid development, but as of version 0.5 we believe it
is sufficiently stable to be run as an internet-facing service for real usage!

About Matrix

Matrix specifies a set of pragmatic RESTful HTTP JSON APIs as an open standard,
which handle:

- Creating and managing fully distributed chat rooms with no
  single points of control or failure
- Eventually-consistent cryptographically secure synchronisation of room
  state across a global open network of federated servers and services
- Sending and receiving extensible messages in a room with (optional)
  end-to-end encryption[1]
- Inviting, joining, leaving, kicking, banning room members
- Managing user accounts (registration, login, logout)
- Using 3rd Party IDs (3PIDs) such as email addresses, phone numbers,
  Facebook accounts to authenticate, identify and discover users on Matrix.
- Placing 1:1 VoIP and Video calls

These APIs are intended to be implemented on a wide range of servers, services
and clients, letting developers build messaging and VoIP functionality on top
of the entirely open Matrix ecosystem rather than using closed or proprietary
solutions. The hope is for Matrix to act as the building blocks for a new
generation of fully open and interoperable messaging and VoIP apps for the

Synapse is a reference "homeserver" implementation of Matrix from the core
55 56 57 58
development team at, written in Python/Twisted.  It is intended to
showcase the concept of Matrix and let folks see the spec in the context of a
codebase and let you run your own homeserver and generally help bootstrap the
59 60

In Matrix, every user runs one or more Matrix clients, which connect through to
61 62 63 64 65 66 67
a Matrix homeserver. The homeserver stores all their personal chat history and
user account information - much as a mail client connects through to an
IMAP/SMTP server. Just like email, you can either run your own Matrix
homeserver and control and own your own communications and history or use one
hosted by someone else (e.g. - there is no single point of control
or mandatory service provider in Matrix, unlike WhatsApp, Facebook, Hangouts,
68 69

We'd like to invite you to join (via
70, run a homeserver, take a look
71 72
at the `Matrix spec <>`_, and experiment with the
`APIs <>`_ and `Client SDKs
74 75 76

Thanks for using Matrix!

77 78
[1] End-to-end encryption is currently in beta: `blog post <>`_.

79 80 81 82

Synapse Installation

For details on how to install synapse, see `<>`_.


86 87 88 89
Connecting to Synapse from a client

The easiest way to try out your new Synapse installation is by connecting to it
90 91 92 93 94 95 96 97 98 99 100 101 102 103
from a web client.

Unless you are running a test instance of Synapse on your local machine, in
general, you will need to enable TLS support before you can successfully
connect from a client: see `<>`_.

An easy way to get started is to login or register via Riot at or respectively. 
You will need to change the server you are logging into from ````
and instead specify a Homeserver URL of ``https://<server_name>:8448`` 
(or just ``https://<server_name>`` if you are using a reverse proxy). 
(Leave the identity server as the default - see `Identity servers`_.) 
If you prefer to use another client, refer to our 
`client breakdown <>`_.

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
If all goes well you should at least be able to log in, create a room, and
start sending messages.

.. _`client-user-reg`:

Registering a new user from a client

By default, registration of new users via Matrix clients is disabled. To enable
it, specify ``enable_registration: true`` in ``homeserver.yaml``. (It is then
recommended to also set up CAPTCHA - see `<docs/CAPTCHA_SETUP.rst>`_.)

Once ``enable_registration`` is set to ``true``, it is possible to register a
user via ` <>`_ or other Matrix clients.

Your new user name will be formed partly from the ``server_name`` (see
`Configuring synapse`_), and partly from a localpart you specify when you
create the account. Your name will take the form of::

(pronounced "at localpart on my dot domain dot name").

As when logging in, you will need to specify a "Custom server".  Specify your
desired ``localpart`` in the 'User name' box.

131 132 133 134 135 136
ACME setup

For details on having Synapse manage your federation TLS certificates
automatically, please see `<docs/>`_.


138 139 140
Security Note

Matrix serves raw user generated data in some APIs - specifically the `content
repository endpoints <>`_.

144 145 146 147 148 149 150
Whilst we have tried to mitigate against possible XSS attacks (e.g. we recommend running
matrix homeservers on a dedicated domain name, to limit any malicious user generated
content served to web browsers a matrix API from being able to attack webapps hosted
on the same domain.  This is particularly true of sharing a matrix webclient and
server on the same domain.

See and
152 153 for more details.

154 155 156

Running out of File Handles
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177

If synapse runs out of filehandles, it typically fails badly - live-locking
at 100% CPU, and/or failing to accept new TCP connections (blocking the
connecting client).  Matrix currently can legitimately use a lot of file handles,
thanks to busy rooms like containing hundreds of participating
servers.  The first time a server talks in a room it will try to connect
simultaneously to all participating servers, which could exhaust the available
file descriptors between DNS queries & HTTPS sockets, especially if DNS is slow
to respond.  (We need to improve the routing algorithm used to be better than
full mesh, but as of June 2017 this hasn't happened yet).

If you hit this failure mode, we recommend increasing the maximum number of
open file handles to be at least 4096 (assuming a default of 1024 or 256).
This is typically done by editing ``/etc/security/limits.conf``

Separately, Synapse may leak file handles if inbound HTTP requests get stuck
during processing - e.g. blocked behind a lock or talking to a remote server etc.
This is best diagnosed by matching up the 'Received request' and 'Processed request'
log lines and looking for any 'Processed request' lines which take more than
a few seconds to execute.  Please let us know at if
179 180
you see this failure mode so we can help debug it, however.

181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
Help!! Synapse eats all my RAM!

Synapse's architecture is quite RAM hungry currently - we deliberately
cache a lot of recent room data and metadata in RAM in order to speed up
common requests.  We'll improve this in future, but for now the easiest
way to either reduce the RAM usage (at the risk of slowing things down)
is to set the almost-undocumented ``SYNAPSE_CACHE_FACTOR`` environment
variable.  The default is 0.5, which can be decreased to reduce RAM usage
in memory constrained enviroments, or increased if performance starts to

Using `libjemalloc <>`_ can also yield a significant
improvement in overall amount, and especially in terms of giving back RAM
to the OS. To use it, the library must simply be put in the LD_PRELOAD
environment variable when launching Synapse. On Debian, this can be done
by installing the ``libjemalloc1`` package and adding this line to


202 203
This can make a significant difference on Python 2.7 - it's unclear how
much of an improvement it provides on Python 3.x.
204 205 206 207 208 209 210 211 212 213

Upgrading an existing Synapse

The instructions for upgrading synapse are in `UPGRADE.rst`_.
Please check these instructions as upgrading may require extra steps for some
versions of synapse.

.. _UPGRADE.rst: UPGRADE.rst

214 215
.. _federation:

216 217 218
Setting up Federation

219 220 221 222
Federation is the process by which users on different servers can participate
in the same room. For this to work, those other servers must be able to contact
yours to send messages.

223 224 225 226 227 228
The ``server_name`` in your ``homeserver.yaml`` file determines the way that
other servers will reach yours. By default, they will treat it as a hostname
and try to connect to port 8448. This is easy to set up and will work with the
default configuration, provided you set the ``server_name`` to match your
machine's public DNS hostname, and give Synapse a TLS certificate which is
valid for your ``server_name``.
229 230 231 232 233 234

For a more flexible configuration, you can set up a DNS SRV record. This allows
you to run your server on a machine that might not have the same name as your
domain name. For example, you might want to run your server at
````, but have your Matrix user-ids look like
````. (A SRV record also allows you to change the port from
the default 8448).

237 238 239
To use a SRV record, first create your SRV record and publish it in DNS. This
should have the format ``_matrix._tcp.<> <ttl> IN SRV 10 0 <port>
<>``. The DNS record should then look something like::

241 242
    $ dig -t srv 3600    IN      SRV     10 0 8448

244 245 246
Note that the server hostname cannot be an alias (CNAME record): it has to point
directly to the server hosting the synapse instance.

247 248
You can then configure your homeserver to use ``<>`` as the domain in
its user-ids, by setting ``server_name``::
249 250

    python -m \
        --server-name <> \
252 253 254 255
        --config-path homeserver.yaml \
    python -m --config-path homeserver.yaml

256 257 258
If you've already generated the config file, you need to edit the ``server_name``
in your ``homeserver.yaml`` file. If you've already started Synapse and a
database has been created, you will have to recreate the database.

260 261 262 263
If all goes well, you should be able to `connect to your server with a client`__,
and then join a room via federation. (Try ```` as a first
step. "Matrix HQ"'s sheer size and activity level tends to make even the
largest boxes pause for thought.)

.. __: `Connecting to Synapse from a client`_

267 268

270 271
You can use the `federation tester <>`_ to
check if your homeserver is all set.

273 274 275 276 277 278 279 280 281 282 283 284 285
The typical failure mode with federation is that when you try to join a room,
it is rejected with "401: Unauthorized". Generally this means that other
servers in the room couldn't access yours. (Joining a room over federation is a
complicated dance which requires connections in both directions).

So, things to check are:

* If you are not using a SRV record, check that your ``server_name`` (the part
  of your user-id after the ``:``) matches your hostname, and that port 8448 on
  that hostname is reachable from outside your network.
* If you *are* using a SRV record, check that it matches your ``server_name``
  (it should be ``_matrix._tcp.<server_name>``), and that the port and hostname
  it specifies are reachable from outside your network.

287 288 289 290 291
Another common problem is that people on other servers can't join rooms that
you invite them to. This can be caused by an incorrectly-configured reverse
proxy: see `<docs/reverse_proxy.rst>`_ for instructions on how to correctly
configure a reverse proxy.

292 293
Running a Demo Federation of Synapses

295 296 297
If you want to get up and running quickly with a trio of homeservers in a
private federation, there is a script in the ``demo`` directory. This is mainly
useful just for development purposes. See `<demo/README>`_.
298 299

300 301 302
Using PostgreSQL

303 304
As of Synapse 0.9, `PostgreSQL <>`_ is supported as an
alternative to the `SQLite <>`_ database that Synapse has
traditionally used for convenience and simplicity.

The advantages of Postgres include:

309 310 311 312 313 314
* significant performance improvements due to the superior threading and
  caching model, smarter query optimiser
* allowing the DB to be run on separate hardware
* allowing basic active/backup high-availability with a "hot spare" synapse
  pointing at the same DB master, as well as enabling DB replication in
  synapse itself.

316 317 318 319 320 321 322 323
For information on how to install and use PostgreSQL, please see
`docs/postgres.rst <docs/postgres.rst>`_.

.. _reverse-proxy:

Using a reverse proxy with Synapse

It is recommended to put a reverse proxy such as
`nginx <>`_,
326 327
`Apache <>`_,
`Caddy <>`_ or
`HAProxy <>`_ in front of Synapse. One advantage of
329 330 331
doing so is that it means that you can expose the default https port (443) to
Matrix clients without needing to run Synapse with root privileges.

For information on configuring one, see `<docs/reverse_proxy.rst>`_.
333 334 335 336

Identity Servers

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
Identity servers have the job of mapping email addresses and other 3rd Party
IDs (3PIDs) to Matrix user IDs, as well as verifying the ownership of 3PIDs
before creating that mapping.

**They are not where accounts or credentials are stored - these live on home
servers. Identity Servers are just for mapping 3rd party IDs to matrix IDs.**

This process is very security-sensitive, as there is obvious risk of spam if it
is too easy to sign up for Matrix accounts or harvest 3PID data. In the longer
term, we hope to create a decentralised system to manage it (`matrix-doc #712
<>`_), but in the meantime,
the role of managing trusted identity in the Matrix ecosystem is farmed out to
a cluster of known trusted ecosystem partners, who run 'Matrix Identity
Servers' such as `Sydent <>`_, whose role
is purely to authenticate and track 3PID logins and publish end-user public

354 355 356 357
You can host your own copy of Sydent, but this will prevent you reaching other
users in the Matrix ecosystem via their email address, and prevent them finding
you. We therefore recommend that you use one of the centralised identity servers
at ```` or ```` for now.

359 360 361
To reiterate: the Identity server will only be used if you choose to associate
an email address with your account, or send an invite to another user via their
email address.


364 365 366 367
Password reset

If a user has registered an email address to their account using an identity
server, they can request a password-reset token via clients such as Riot.
369 370 371

A manual password reset can be done via direct database access as follows.

First calculate the hash of the new password::

    $ ~/synapse/env/bin/hash_password
375 376
    Confirm password:
377 378

Then update the `users` table in the database::
380 381 382

    UPDATE users SET password_hash='$2a$12$xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
        WHERE name='';
383 384

385 386 387 388 389
Synapse Development

Before setting up a development environment for synapse, make sure you have the
system dependencies (such as the python header files) installed - see
`Installing from source <>`_.
391 392 393 394 395 396 397 398 399 400

To check out a synapse for development, clone the git repo into a working
directory of your choice::

    git clone
    cd synapse

Synapse has a number of external dependencies, that are easiest
to install using pip and a virtualenv::

    virtualenv -p python3 env
    source env/bin/activate
    python -m pip install -e .[all]
404 405 406 407 408 409 410

This will run a process of downloading and installing all the needed
dependencies into a virtual env.

Once this is done, you may wish to run Synapse's unit tests, to
check that everything is installed as it should be::

    python -m twisted.trial tests
412 413 414 415 416 417

This should end with a 'PASSED' result::

    Ran 143 tests in 0.601s

    PASSED (successes=143)

419 420 421 422 423 424 425 426 427 428 429
Running the Integration Tests

Synapse is accompanied by `SyTest <>`_,
a Matrix homeserver integration testing suite, which uses HTTP requests to
access the API as a Matrix client would. It is able to run Synapse directly from
the source tree, so installation of the server is not required.

Testing with SyTest is recommended for verifying that changes related to the
Client-Server API are functioning correctly. See the `installation instructions
<>`_ for details.
430 431 432 433 434 435 436 437 438 439 440 441 442

Building Internal API Documentation

Before building internal API documentation install sphinx and

    pip install sphinx
    pip install sphinxcontrib-napoleon

Building internal API documentation::

    python build_sphinx