mirror of
https://github.com/element-hq/synapse.git
synced 2024-11-21 17:15:38 +03:00
Remove documentation referencing Cygwin (#3873)
This commit is contained in:
parent
3d6b24fb1b
commit
3f0d8e6b09
3 changed files with 10 additions and 31 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -4,6 +4,7 @@
|
||||||
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
_trial_temp/
|
_trial_temp/
|
||||||
|
_trial_temp*/
|
||||||
logs/
|
logs/
|
||||||
dbs/
|
dbs/
|
||||||
*.egg
|
*.egg
|
||||||
|
|
38
README.rst
38
README.rst
|
@ -157,7 +157,7 @@ if you prefer.
|
||||||
|
|
||||||
In case of problems, please see the _`Troubleshooting` section below.
|
In case of problems, please see the _`Troubleshooting` section below.
|
||||||
|
|
||||||
There is an offical synapse image available at
|
There is an offical synapse image available at
|
||||||
https://hub.docker.com/r/matrixdotorg/synapse/tags/ which can be used with
|
https://hub.docker.com/r/matrixdotorg/synapse/tags/ which can be used with
|
||||||
the docker-compose file available at `contrib/docker <contrib/docker>`_. Further information on
|
the docker-compose file available at `contrib/docker <contrib/docker>`_. Further information on
|
||||||
this including configuration options is available in the README on
|
this including configuration options is available in the README on
|
||||||
|
@ -459,37 +459,13 @@ https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/matrix-
|
||||||
|
|
||||||
Windows Install
|
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``
|
|
||||||
|
|
||||||
|
If you wish to run or develop Synapse on Windows, the Windows Subsystem For
|
||||||
|
Linux provides a Linux environment on Windows 10 which is capable of using the
|
||||||
|
Debian, Fedora, or source installation methods. More information about WSL can
|
||||||
|
be found at https://docs.microsoft.com/en-us/windows/wsl/install-win10 for
|
||||||
|
Windows 10 and https://docs.microsoft.com/en-us/windows/wsl/install-on-server
|
||||||
|
for Windows Server.
|
||||||
|
|
||||||
Troubleshooting
|
Troubleshooting
|
||||||
===============
|
===============
|
||||||
|
|
2
changelog.d/3873.misc
Normal file
2
changelog.d/3873.misc
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
Remove documentation regarding installation on Cygwin, the use of WSL is
|
||||||
|
recommended instead.
|
Loading…
Reference in a new issue