diff options
| author | Erik Johnston <erik@matrix.org> | 2015-04-27 14:41:40 +0100 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2015-04-27 14:41:40 +0100 |
| commit | 6f8e2d517e8141f62cb0cfcc73c3842a367ff21c (patch) | |
| tree | 4f4569d1bbf7b6fcc2a67c1664da38b75e81a5ee /README.rst | |
| parent | Shuffle operations so that locking upsert happens last in the txn. This ensur... (diff) | |
| parent | Merge pull request #132 from matrix-org/observer_and_locks (diff) | |
| download | synapse-6f8e2d517e8141f62cb0cfcc73c3842a367ff21c.tar.xz | |
Merge branch 'develop' of github.com:matrix-org/synapse into postgres
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/README.rst b/README.rst index 14ef6c5acf..714ad6443d 100644 --- a/README.rst +++ b/README.rst @@ -86,7 +86,7 @@ Homeserver Installation ======================= System requirements: -- POSIX-compliant system (tested on Linux & OSX) +- POSIX-compliant system (tested on Linux & OS X) - Python 2.7 Synapse is written in python but some of the libraries is uses are written in @@ -128,6 +128,15 @@ To set up your homeserver, run (in your virtualenv, as before):: 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 +identify itself to other Home Servers, so don't lose or delete them. It would be +wise to back them up somewhere safe. If, for whatever reason, you do need to +change your Home Server's keys, you may find that other Home Servers have the +old key cached. If you update the signing key, you should change the name of the +key in the <server name>.signing.key file (the second word, which by default is +, 'auto') to something different. + 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 @@ -367,10 +376,6 @@ SRV record, as that is the name other machines will expect it to have:: You may additionally want to pass one or more "-v" options, in order to increase the verbosity of logging output; at least for initial testing. -For the initial alpha release, the homeserver is not speaking TLS for -either client-server or server-server traffic for ease of debugging. We have -also not spent any time yet getting the homeserver to run behind loadbalancers. - Running a Demo Federation of Homeservers ---------------------------------------- @@ -433,7 +438,7 @@ track 3PID logins and publish end-user public keys. It's currently early days for identity servers as Matrix is not yet using 3PIDs as the primary means of identity and E2E encryption is not complete. As such, -we are running a single identity server (http://matrix.org:8090) at the current +we are running a single identity server (https://matrix.org) at the current time. |