mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-27 12:08:32 +03:00
Code Issues Projects Releases Packages Wiki Activity

Bluntly port changes of README from develop to master

Browse source
This commit is contained in:
Erik Johnston 2015-02-04 23:48:32 +00:00
parent 30ed0884fc
commit 3b5e8125eb
1 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.rst
View file

@ -111,6 +111,15 @@ To install the synapse homeserver run::
This installs synapse, along with the libraries it uses, into a virtual
environment under ``~/.synapse``.
To set up your homeserver, run (in your virtualenv, as before)::
$ python -m synapse.app.homeserver \
--server-name machine.my.domain.name \
--config-path homeserver.yaml \
--generate-config
Substituting your host and domain name as appropriate.
For reliable VoIP calls to be routed via this homeserver, you MUST configure
a TURN server. See docs/turn-howto.rst for details.
@ -213,7 +222,7 @@ to install using pip and a virtualenv::
$ virtualenv env
$ source env/bin/activate
$ python synapse/dependencies | xargs -i pip install
$ python synapse/python_dependencies.py | xargs -n1 pip install
$ pip install setuptools_trial mock
This will run a process of downloading and installing all the needed
@ -265,9 +274,9 @@ For the first form, simply pass the required hostname (of the machine) as the
$ python -m synapse.app.homeserver \
--server-name machine.my.domain.name \
--config-path homeserver.config \
--config-path homeserver.yaml \
--generate-config
$ python -m synapse.app.homeserver --config-path homeserver.config
$ python -m synapse.app.homeserver --config-path homeserver.yaml
Alternatively, you can run ``synctl start`` to guide you through the process.
@ -287,9 +296,9 @@ SRV record, as that is the name other machines will expect it to have::
$ python -m synapse.app.homeserver \
--server-name YOURDOMAIN \
--bind-port 8448 \
--config-path homeserver.config \
--config-path homeserver.yaml \
--generate-config
$ python -m synapse.app.homeserver --config-path homeserver.config
$ python -m synapse.app.homeserver --config-path homeserver.yaml
You may additionally want to pass one or more "-v" options, in order to