summary refs log tree commit diff
path: root/README.rst
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2014-09-01 20:21:43 +0100
committerMark Haines <mark.haines@matrix.org>2014-09-01 20:22:16 +0100
commit86fa1138be3e7908b6960498b31c2df9b286ef0a (patch)
tree63076588fa161c6cf887f2770eead8b58e37665f /README.rst
parentMerge branch 'server2server_tls' into develop (diff)
downloadsynapse-86fa1138be3e7908b6960498b31c2df9b286ef0a.tar.xz
Update readme with instructions on how to generate configs for homeservers
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index cfdc2a1c75..9c44bf61b8 100644
--- a/README.rst
+++ b/README.rst
@@ -173,7 +173,11 @@ IDs:
 For the first form, simply pass the required hostname (of the machine) as the
 --host parameter::
 
-    $ python synapse/app/homeserver.py --host machine.my.domain.name
+    $ python synapse/app/homeserver.py \
+        --server-name machine.my.domain.name \
+        --config-path homeserver.config \
+        --generate-config
+    $ python synapse/app/homeserver.py --config-path homeserver.config
 
 For the second form, first create your SRV record and publish it in DNS. This
 needs to be named _matrix._tcp.YOURDOMAIN, and point at at least one hostname
@@ -186,7 +190,13 @@ record would then look something like::
 At this point, you should then run the homeserver with the hostname of this
 SRV record, as that is the name other machines will expect it to have::
 
-    $ python synapse/app/homeserver.py --host my.domain.name --port 8448
+    $ python synapse/app/homeserver.py \
+        --server-name YOURDOMAIN \
+        --bind-port 8448 \
+        --config-path homeserver.config \
+        --generate-config
+    $ python synapse/app/homeserver.py --config-path homeserver.config
+
 
 You may additionally want to pass one or more "-v" options, in order to
 increase the verbosity of logging output; at least for initial testing.