Merge branch 'develop' into pushers
Conflicts:
synapse/api/errors.py
synapse/server.py
synapse/storage/__init__.py
1 files changed, 31 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 8459bcac2e..f5d2b0af38 100644
--- a/README.rst
+++ b/README.rst
@@ -133,6 +133,37 @@ failing, e.g.::
On OSX, if you encounter clang: error: unknown argument: '-mno-fused-madd' you
will need to export CFLAGS=-Qunused-arguments.
+Windows Install
+---------------
+Synapse can be installed on Cygwin. It requires the following Cygwin packages:
+
+ - gcc
+ - git
+ - libffi-devel
+ - openssl (and openssl-devel, python-openssl)
+ - python
+ - python-setuptools
+
+The content repository requires additional packages and will be unable to process
+uploads without them:
+ - libjpeg8
+ - libjpeg8-devel
+ - zlib
+If you choose to install Synapse without these packages, you will need to reinstall
+``pillow`` for changes to be applied, e.g. ``pip uninstall pillow`` ``pip install
+pillow --user``
+
+Troubleshooting:
+
+- You may need to upgrade ``setuptools`` to get this to work correctly:
+ ``pip install setuptools --upgrade``.
+- You may encounter errors indicating that ``ffi.h`` is missing, even with
+ ``libffi-devel`` installed. If you do, copy the ``.h`` files:
+ ``cp /usr/lib/libffi-3.0.13/include/*.h /usr/include``
+- You may need to install libsodium from source in order to install PyNacl. If
+ you do, you may need to create a symlink to ``libsodium.a`` so ``ld`` can find
+ it: ``ln -s /usr/local/lib/libsodium.a /usr/lib/libsodium.a``
+
Running Your Homeserver
=======================
|
