summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthew Hodgson <matthew@matrix.org>2015-01-08 20:36:34 +0000
committerMatthew Hodgson <matthew@matrix.org>2015-01-08 20:37:08 +0000
commit80e89772e2d531941bf4403ecf3d539557763985 (patch)
tree88c6aba875b615d4ebb3a33178d7f5d7c7f4948b
parentCheck the existance and versions of necessary modules when starting synapse, ... (diff)
downloadsynapse-80e89772e2d531941bf4403ecf3d539557763985.tar.xz
spell out that local libs may need to be explicitly given priority
-rw-r--r--README.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 92b94bcd7d..2be201178f 100644
--- a/README.rst
+++ b/README.rst
@@ -108,6 +108,15 @@ 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.
 
+Your python may not give priority to locally installed libraries over system
+libraries, in which case you must add your local packages to your python path::
+
+    $ # on Linux:
+    $ export PYTHONPATH=$HOME/.local/lib/python2.7/site-packages
+
+    $ # on OSX:
+    $ export PYTHONPATH=$HOME/Library/Python/2.7/lib/python2.7/site-packages
+
 For reliable VoIP calls to be routed via this homeserver, you MUST configure
 a TURN server.  See docs/turn-howto.rst for details.