diff options
| author | Matthew Hodgson <matthew@matrix.org> | 2015-12-01 23:05:03 +0000 |
|---|---|---|
| committer | Matthew Hodgson <matthew@matrix.org> | 2015-12-01 23:05:12 +0000 |
| commit | 65a9bf2dd5841d6da638025acf48ab3e2ee30675 (patch) | |
| tree | cb1a639009716004c8491ee2fdf15bf8e36ae892 /README.rst | |
| parent | Fix definitions script (diff) | |
| download | synapse-65a9bf2dd5841d6da638025acf48ab3e2ee30675.tar.xz | |
various fixes - thanks to Mark White for pointing out you need to run synapse before you try to register a new user
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/README.rst b/README.rst index 9149f2feec..3014edaac7 100644 --- a/README.rst +++ b/README.rst @@ -155,7 +155,7 @@ To set up your homeserver, run (in your virtualenv, as before):: --generate-config \ --report-stats=[yes|no] -Substituting your host and domain name as appropriate. +...substituting your host and domain name as appropriate. This will generate you a config file that you can then customise, but it will also generate a set of keys for you. These keys will allow your Home Server to @@ -168,10 +168,11 @@ key in the <server name>.signing.key file (the second word, which by default is By default, registration of new users is disabled. You can either enable registration in the config by specifying ``enable_registration: true`` -(it is then recommended to also set up CAPTCHA), or +(it is then recommended to also set up CAPTCHA - see docs/CAPTCHA_SETUP), or you can use the command line to register new users:: $ source ~/.synapse/bin/activate + $ synctl start # if not already running $ register_new_matrix_user -c homeserver.yaml https://localhost:8448 New user localpart: erikj Password: @@ -181,6 +182,16 @@ you can use the command line to register new users:: For reliable VoIP calls to be routed via this homeserver, you MUST configure a TURN server. See docs/turn-howto.rst for details. +Running Synapse +=============== + +To actually run your new homeserver, pick a working directory for Synapse to +run (e.g. ``~/.synapse``), and:: + + cd ~/.synapse + source ./bin/activate + synctl start + Using PostgreSQL ================ @@ -203,16 +214,6 @@ may have a few regressions relative to SQLite. For information on how to install and use PostgreSQL, please see `docs/postgres.rst <docs/postgres.rst>`_. -Running Synapse -=============== - -To actually run your new homeserver, pick a working directory for Synapse to -run (e.g. ``~/.synapse``), and:: - - cd ~/.synapse - source ./bin/activate - synctl start - Platform Specific Instructions ============================== |