diff options
| author | Erik Johnston <erik@matrix.org> | 2016-02-10 10:40:28 +0000 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2016-02-10 10:40:28 +0000 |
| commit | 46a02ff15b419dffecd47d7350bcecd60c068af3 (patch) | |
| tree | 20eec03412980e56f4c763360deb3ca223ca5b7e | |
| parent | Merge pull request #565 from matrix-org/erikj/macaroon_config (diff) | |
| parent | Update documentation (diff) | |
| download | synapse-46a02ff15b419dffecd47d7350bcecd60c068af3.tar.xz | |
Merge pull request #532 from floviolleau/floviolleau/documentation
Update documentation
| -rw-r--r-- | AUTHORS.rst | 3 | ||||
| -rw-r--r-- | README.rst | 23 |
2 files changed, 25 insertions, 1 deletions
diff --git a/AUTHORS.rst b/AUTHORS.rst index f19d17d24f..07d4bee2a3 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -51,3 +51,6 @@ Steven Hammerton <steven.hammerton at openmarket.com> Mads Robin Christensen <mads at v42 dot dk> * CentOS 7 installation instructions. + +Florent Violleau <floviolleau at gmail dot com> + * Add Raspberry Pi installation instructions and general troubleshooting items \ No newline at end of file diff --git a/README.rst b/README.rst index 297e72f1ae..39a338c790 100644 --- a/README.rst +++ b/README.rst @@ -125,6 +125,15 @@ Installing prerequisites on Mac OS X:: sudo easy_install pip sudo pip install virtualenv +Installing prerequisites on Raspbian:: + + sudo apt-get install build-essential python2.7-dev libffi-dev \ + python-pip python-setuptools sqlite3 \ + libssl-dev python-virtualenv libjpeg-dev + sudo pip install --upgrade pip + sudo pip install --upgrade ndg-httpsclient + sudo pip install --upgrade virtualenv + To install the synapse homeserver run:: virtualenv -p python2.7 ~/.synapse @@ -310,6 +319,18 @@ may need to manually upgrade it:: sudo pip install --upgrade pip +Installing may fail with ``Could not find any downloads that satisfy the requirement pymacaroons-pynacl (from matrix-synapse==0.12.0)``. +You can fix this by manually upgrading pip and virtualenv:: + + sudo pip install --upgrade virtualenv + +You can next rerun ``virtualenv -p python2.7 synapse`` to update the virtual env. + +Installing may fail during installing virtualenv with ``InsecurePlatformWarning: A true SSLContext object is not available. This prevents urllib3 from configuring SSL appropriately and may cause certain SSL connections to fail. For more information, see https://urllib3.readthedocs.org/en/latest/security.html#insecureplatformwarning.`` +You can fix this by manually installing ndg-httpsclient:: + + pip install --upgrade ndg-httpsclient + Installing may fail with ``mock requires setuptools>=17.1. Aborting installation``. You can fix this by upgrading setuptools:: @@ -544,4 +565,4 @@ sphinxcontrib-napoleon:: Building internal API documentation:: python setup.py build_sphinx - + \ No newline at end of file |