summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Baker <dave@matrix.org>2015-01-30 17:11:29 +0000
committerDavid Baker <dave@matrix.org>2015-01-30 17:11:29 +0000
commit166c2cd4f3e3828668f73bb1f8248d850234fc5c (patch)
tree5e94885d9ff1ea7749080526ba218cbc35d3f529
parentTell people to "source" the activate script for virtualenv, Remove --user fro... (diff)
downloadsynapse-166c2cd4f3e3828668f73bb1f8248d850234fc5c.tar.xz
add generate config instruction to the HS setup part
Diffstat (limited to '')
-rw-r--r--README.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 285865f5f0..820b16d06c 100644
--- a/README.rst
+++ b/README.rst
@@ -110,6 +110,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.config \
+        --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.