diff options
| author | Erik Johnston <erik@matrix.org> | 2015-01-06 10:53:04 +0000 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2015-01-06 10:53:04 +0000 |
| commit | 96a5ba41f503982dfa8b7d669161ea43b0529189 (patch) | |
| tree | 4ad40ec4cac09fd67b01cd10ce6f99e295953b72 /README.rst | |
| parent | Merge branch 'master' of github.com:matrix-org/synapse into erikj-perf (diff) | |
| parent | spell out that VoIP needs TURN (diff) | |
| download | synapse-96a5ba41f503982dfa8b7d669161ea43b0529189.tar.xz | |
Merge branch 'develop' of github.com:matrix-org/synapse into erikj-perf
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/README.rst b/README.rst index f5d2b0af38..92b94bcd7d 100644 --- a/README.rst +++ b/README.rst @@ -108,6 +108,9 @@ To install the synapse homeserver run:: This installs synapse, along with the libraries it uses, into ``$HOME/.local/lib/`` on Linux or ``$HOME/Library/Python/2.7/lib/`` on OSX. +For reliable VoIP calls to be routed via this homeserver, you MUST configure +a TURN server. See docs/turn-howto.rst for details. + Troubleshooting Installation ---------------------------- @@ -239,6 +242,11 @@ Upgrading an existing homeserver IMPORTANT: Before upgrading an existing homeserver to a new version, please refer to UPGRADE.rst for any additional instructions. +Otherwise, simply re-install the new codebase over the current one - e.g. +by ``pip install --user --process-dependency-links +https://github.com/matrix-org/synapse/tarball/master`` +if using pip, or by ``git pull`` if running off a git working copy. + Setting up Federation ===================== |