README.rst 16.8 KB
Newer Older
1 2 3
=========================================================
Synapse |support| |development| |license| |pypi| |python|
=========================================================
4

Matthew Hodgson's avatar
Matthew Hodgson committed
5 6
.. contents::

7 8
Introduction
============
9

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

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

- Matrix user IDs look like ``@matthew:matrix.org`` (although in the future
Richard van der Hoff's avatar
Richard van der Hoff committed
18
  you will normally refer to yourself and others using a third party identifier
evelynmitchell's avatar
evelynmitchell committed
19
  (3PID): email address, phone number, etc rather than manipulating Matrix user IDs)
Matthew Hodgson's avatar
Matthew Hodgson committed
20 21 22

The overall architecture is::

Matthew Hodgson's avatar
Matthew Hodgson committed
23
      client <----> homeserver <=====================> homeserver <----> client
24
             https://somewhere.org/_matrix      https://elsewhere.net/_matrix
25

26
``#matrix:matrix.org`` is the official support room for Matrix, and can be
27
accessed by any client from https://matrix.org/docs/projects/try-matrix-now.html or
Richard van der Hoff's avatar
Richard van der Hoff committed
28
via IRC bridge at irc://irc.freenode.net/matrix.
29

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

33 34
About Matrix
============
35

Matthew Hodgson's avatar
Matthew Hodgson committed
36 37
Matrix specifies a set of pragmatic RESTful HTTP JSON APIs as an open standard,
which handle:
38

39 40
- Creating and managing fully distributed chat rooms with no
  single points of control or failure
41
- Eventually-consistent cryptographically secure synchronisation of room
42 43
  state across a global open network of federated servers and services
- Sending and receiving extensible messages in a room with (optional)
44
  end-to-end encryption
45 46 47 48 49
- 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
50 51

These APIs are intended to be implemented on a wide range of servers, services
52 53
and clients, letting developers build messaging and VoIP functionality on top
of the entirely open Matrix ecosystem rather than using closed or proprietary
54 55 56
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
internet.
57 58

Synapse is a reference "homeserver" implementation of Matrix from the core
Richard van der Hoff's avatar
Richard van der Hoff committed
59 60 61 62
development team at matrix.org, 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
ecosystem.
63 64

In Matrix, every user runs one or more Matrix clients, which connect through to
65 66 67 68 69 70 71
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. matrix.org) - there is no single point of control
or mandatory service provider in Matrix, unlike WhatsApp, Facebook, Hangouts,
etc.
72

73
We'd like to invite you to join #matrix:matrix.org (via
74
https://matrix.org/docs/projects/try-matrix-now.html), run a homeserver, take a look
Richard van der Hoff's avatar
Richard van der Hoff committed
75 76
at the `Matrix spec <https://matrix.org/docs/spec>`_, and experiment with the
`APIs <https://matrix.org/docs/api>`_ and `Client SDKs
Peter's avatar
Peter committed
77
<https://matrix.org/docs/projects/try-matrix-now.html#client-sdks>`_.
Matthew Hodgson's avatar
Matthew Hodgson committed
78

79 80
Thanks for using Matrix!

81 82 83 84 85 86 87 88 89 90 91
Support
=======

For support installing or managing Synapse, please join |room|_ (from a matrix.org
account if necessary) and ask questions there. We do not use GitHub issues for
support requests, only for bug reports and feature requests.

.. |room| replace:: ``#synapse:matrix.org``
.. _room: https://matrix.to/#/#synapse:matrix.org


92 93 94
Synapse Installation
====================

95 96 97 98
.. _federation:

* For details on how to install synapse, see `<INSTALL.md>`_.
* For specific details on how to configure Synapse for federation see `docs/federate.md <docs/federate.md>`_
matrix.org's avatar
matrix.org committed
99

100

101 102
Connecting to Synapse from a client
===================================
Richard van der Hoff's avatar
Richard van der Hoff committed
103

104
The easiest way to try out your new Synapse installation is by connecting to it
Richard van der Hoff's avatar
Richard van der Hoff committed
105 106 107 108 109 110
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 `<INSTALL.md#tls-certificates>`_.

111 112
An easy way to get started is to login or register via Element at
https://app.element.io/#/login or https://app.element.io/#/register respectively.
Richard van der Hoff's avatar
Richard van der Hoff committed
113
You will need to change the server you are logging into from ``matrix.org``
114 115 116
and instead specify a Homeserver URL of ``https://<server_name>:8448``
(or just ``https://<server_name>`` if you are using a reverse proxy).
If you prefer to use another client, refer to our
Richard van der Hoff's avatar
Richard van der Hoff committed
117
`client breakdown <https://matrix.org/docs/projects/clients-matrix>`_.
Max Dor's avatar
Max Dor committed
118

119 120
If all goes well you should at least be able to log in, create a room, and
start sending messages.
Richard van der Hoff's avatar
Richard van der Hoff committed
121

122 123
.. _`client-user-reg`:

124 125
Registering a new user from a client
------------------------------------
Richard van der Hoff's avatar
Richard van der Hoff committed
126

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

Once ``enable_registration`` is set to ``true``, it is possible to register a
132
user via a Matrix client.
133

134 135 136
Your new user name will be formed partly from the ``server_name``, and partly
from a localpart you specify when you create the account. Your name will take
the form of::
Richard van der Hoff's avatar
Richard van der Hoff committed
137

Richard van der Hoff's avatar
Richard van der Hoff committed
138
    @localpart:my.domain.name
Richard van der Hoff's avatar
Richard van der Hoff committed
139

Richard van der Hoff's avatar
Richard van der Hoff committed
140
(pronounced "at localpart on my dot domain dot name").
Richard van der Hoff's avatar
Richard van der Hoff committed
141

142 143
As when logging in, you will need to specify a "Custom server".  Specify your
desired ``localpart`` in the 'User name' box.
Richard van der Hoff's avatar
Richard van der Hoff committed
144

145
ACME setup
Andrew Morgan's avatar
Andrew Morgan committed
146
==========
147 148 149 150

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

Richard van der Hoff's avatar
Richard van der Hoff committed
151

152 153 154
Security Note
=============

Richard van der Hoff's avatar
Richard van der Hoff committed
155
Matrix serves raw user generated data in some APIs - specifically the `content
Peter's avatar
Peter committed
156
repository endpoints <https://matrix.org/docs/spec/client_server/latest.html#get-matrix-media-r0-download-servername-mediaid>`_.
Richard van der Hoff's avatar
Richard van der Hoff committed
157

158 159 160 161 162 163 164
Whilst we have tried to mitigate against possible XSS attacks (e.g.
https://github.com/matrix-org/synapse/pull/1021) 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.

165
See https://github.com/vector-im/riot-web/issues/1977 and
166 167
https://developer.github.com/changes/2014-04-25-user-content-security for more details.

matrix.org's avatar
matrix.org committed
168

169 170
Upgrading an existing Synapse
=============================
171

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

176
.. _UPGRADE.rst: UPGRADE.rst
177

178 179 180 181 182
.. _reverse-proxy:

Using a reverse proxy with Synapse
==================================

Max Dor's avatar
Max Dor committed
183
It is recommended to put a reverse proxy such as
184
`nginx <https://nginx.org/en/docs/http/ngx_http_proxy_module.html>`_,
185
`Apache <https://httpd.apache.org/docs/current/mod/mod_proxy_http.html>`_,
186
`Caddy <https://caddyserver.com/docs/quick-starts/reverse-proxy>`_ or
Peter's avatar
Peter committed
187
`HAProxy <https://www.haproxy.org/>`_ in front of Synapse. One advantage of
188 189 190
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.

191
For information on configuring one, see `<docs/reverse_proxy.md>`_.
192

193 194
Identity Servers
================
matrix.org's avatar
matrix.org committed
195

196 197 198 199
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.

Richard van der Hoff's avatar
Richard van der Hoff committed
200 201 202
**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.**

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
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
<https://github.com/matrix-org/matrix-doc/issues/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 <https://github.com/matrix-org/sydent>`_, whose role
is purely to authenticate and track 3PID logins and publish end-user public
keys.

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 ``https://matrix.org`` or ``https://vector.im`` for now.

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.
221

Matthew Hodgson's avatar
Add doc  
Matthew Hodgson committed
222

223 224 225
Password reset
==============

226 227 228
Users can reset their password through their client. Alternatively, a server admin
can reset a users password using the `admin API <docs/admin_api/user_admin_api.rst#reset-password>`_
or by directly editing the database as shown below.
229

Richard van der Hoff's avatar
Richard van der Hoff committed
230
First calculate the hash of the new password::
231

232
    $ ~/synapse/env/bin/hash_password
Richard van der Hoff's avatar
Richard van der Hoff committed
233 234
    Password:
    Confirm password:
235 236
    $2a$12$xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

237
Then update the ``users`` table in the database::
238 239 240

    UPDATE users SET password_hash='$2a$12$xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
        WHERE name='@test:test.com';
241

Richard van der Hoff's avatar
Richard van der Hoff committed
242 243 244 245

Synapse Development
===================

246 247
Join our developer community on Matrix: [#synapse-dev:matrix.org](https://matrix.to/#/#synapse-dev:matrix.org)

248 249
Before setting up a development environment for synapse, make sure you have the
system dependencies (such as the python header files) installed - see
Richard van der Hoff's avatar
Richard van der Hoff committed
250
`Installing from source <INSTALL.md#installing-from-source>`_.
251

Richard van der Hoff's avatar
Richard van der Hoff committed
252 253 254 255 256 257 258 259 260
To check out a synapse for development, clone the git repo into a working
directory of your choice::

    git clone https://github.com/matrix-org/synapse.git
    cd synapse

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

261 262 263
    python3 -m venv ./env
    source ./env/bin/activate
    pip install -e ".[all,test]"
Richard van der Hoff's avatar
Richard van der Hoff committed
264 265

This will run a process of downloading and installing all the needed
chagai95's avatar
chagai95 committed
266 267
dependencies into a virtual env. If any dependencies fail to install,
try installing the failing modules individually::
Richard van der Hoff's avatar
Richard van der Hoff committed
268

chagai95's avatar
chagai95 committed
269 270 271 272
    pip install -e "module-name"

Once this is done, you may wish to run Synapse's unit tests to
check that everything is installed correctly::
Richard van der Hoff's avatar
Richard van der Hoff committed
273

274
    python -m twisted.trial tests
Richard van der Hoff's avatar
Richard van der Hoff committed
275

chagai95's avatar
chagai95 committed
276 277
This should end with a 'PASSED' result (note that exact numbers will
differ)::
Richard van der Hoff's avatar
Richard van der Hoff committed
278

chagai95's avatar
chagai95 committed
279
    Ran 1337 tests in 716.064s
Richard van der Hoff's avatar
Richard van der Hoff committed
280

chagai95's avatar
chagai95 committed
281
    PASSED (skips=15, successes=1322)
Richard van der Hoff's avatar
Richard van der Hoff committed
282

283 284 285 286 287 288 289 290 291 292 293
Running the Integration Tests
=============================

Synapse is accompanied by `SyTest <https://github.com/matrix-org/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
<https://github.com/matrix-org/sytest#installing>`_ for details.
Richard van der Hoff's avatar
Richard van der Hoff committed
294

295 296 297
Troubleshooting
===============

298 299 300
Need help? Join our community support room on Matrix:
`#synapse:matrix.org <https://matrix.to/#/#synapse:matrix.org>`_

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
Running out of File Handles
---------------------------

If synapse runs out of file handles, 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 #matrix:matrix.org 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 March 2019 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 #synapse:matrix.org if
you see this failure mode so we can help debug it, however.

325
Help!! Synapse is slow and eats all my RAM/CPU!
326
-----------------------------------------------
327 328 329

First, ensure you are running the latest version of Synapse, using Python 3
with a PostgreSQL database.
330 331 332 333 334 335 336 337 338 339

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 the 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
degrade.

340 341 342 343 344 345
However, degraded performance due to a low cache factor, common on
machines with slow disks, often leads to explosions in memory use due
backlogged requests. In this case, reducing the cache factor will make
things worse. Instead, try increasing it drastically. 2.0 is a good
starting value.

346
Using `libjemalloc <http://jemalloc.net/>`_ can also yield a significant
347 348 349 350 351
improvement in overall memory use, 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 ``/etc/default/matrix-synapse``::
352 353 354 355 356

    LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.1

This can make a significant difference on Python 2.7 - it's unclear how
much of an improvement it provides on Python 3.x.
357 358 359 360 361 362 363 364 365

If you're encountering high CPU use by the Synapse process itself, you
may be affected by a bug with presence tracking that leads to a
massive excess of outgoing federation requests (see `discussion
<https://github.com/matrix-org/synapse/issues/3971>`_). If metrics
indicate that your server is also issuing far more outgoing federation
requests than can be accounted for by your users' activity, this is a
likely cause. The misbehavior can be worked around by setting
``use_presence: false`` in the Synapse config file.
366 367 368 369 370 371 372 373 374 375 376 377

People can't accept room invitations from me
--------------------------------------------

The typical failure mode here is that you send an invitation to someone 
to join a room or direct chat, but when they go to accept it, they get an
error (typically along the lines of "Invalid signature"). They might see
something like the following in their logs::

    2019-09-11 19:32:04,271 - synapse.federation.transport.server - 288 - WARNING - GET-11752 - authenticate_request failed: 401: Invalid signature for server <server> with key ed25519:a_EqML: Unable to verify signature for <server>

This is normally caused by a misconfiguration in your reverse-proxy. See
378
`<docs/reverse_proxy.md>`_ and double-check that your settings are correct.
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398

.. |support| image:: https://img.shields.io/matrix/synapse:matrix.org?label=support&logo=matrix
  :alt: (get support on #synapse:matrix.org)
  :target: https://matrix.to/#/#synapse:matrix.org

.. |development| image:: https://img.shields.io/matrix/synapse-dev:matrix.org?label=development&logo=matrix
  :alt: (discuss development on #synapse-dev:matrix.org)
  :target: https://matrix.to/#/#synapse-dev:matrix.org

.. |license| image:: https://img.shields.io/github/license/matrix-org/synapse
  :alt: (check license in LICENSE file)
  :target: LICENSE

.. |pypi| image:: https://img.shields.io/pypi/v/matrix-synapse
  :alt: (latest version released on PyPi)
  :target: https://pypi.org/project/matrix-synapse

.. |python| image:: https://img.shields.io/pypi/pyversions/matrix-synapse
  :alt: (supported python versions)
  :target: https://pypi.org/project/matrix-synapse