Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #237 from matrix-org/markjh/readme-rst-formatting 

Clean up some of restructured text formatting in the README.rst
This commit is contained in:
Mark Haines 2015-08-20 16:08:17 +01:00
parent cb8201ba12 8a951540f6
commit d5c31e01f2
1 changed files with 39 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.rst
View File

@ -174,12 +174,12 @@ traditionally used for convenience and simplicity.
The advantages of Postgres include: The advantages of Postgres include:
* significant performance improvements due to the superior threading and * significant performance improvements due to the superior threading and
caching model, smarter query optimiser caching model, smarter query optimiser
* allowing the DB to be run on separate hardware * allowing the DB to be run on separate hardware
* allowing basic active/backup high-availability with a "hot spare" synapse * allowing basic active/backup high-availability with a "hot spare" synapse
pointing at the same DB master, as well as enabling DB replication in pointing at the same DB master, as well as enabling DB replication in
synapse itself. synapse itself.
The only disadvantage is that the code is relatively new as of April 2015 and The only disadvantage is that the code is relatively new as of April 2015 and
may have a few regressions relative to SQLite. may have a few regressions relative to SQLite.
@ -190,8 +190,8 @@ For information on how to install and use PostgreSQL, please see
Running Synapse Running Synapse
=============== ===============
To actually run your new homeserver, pick a working directory for Synapse to run To actually run your new homeserver, pick a working directory for Synapse to
(e.g. ``~/.synapse``), and:: run (e.g. ``~/.synapse``), and::
cd ~/.synapse cd ~/.synapse
source ./bin/activate source ./bin/activate
@ -243,18 +243,20 @@ Windows Install
--------------- ---------------
Synapse can be installed on Cygwin. It requires the following Cygwin packages: Synapse can be installed on Cygwin. It requires the following Cygwin packages:
- gcc - gcc
- git - git
- libffi-devel - libffi-devel
- openssl (and openssl-devel, python-openssl) - openssl (and openssl-devel, python-openssl)
- python - python
- python-setuptools - python-setuptools
The content repository requires additional packages and will be unable to process The content repository requires additional packages and will be unable to process
uploads without them: uploads without them:
- libjpeg8
- libjpeg8-devel - libjpeg8
- zlib - libjpeg8-devel
- zlib
If you choose to install Synapse without these packages, you will need to reinstall 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`` for changes to be applied, e.g. ``pip uninstall pillow`` ``pip install
pillow --user`` pillow --user``