summary refs log tree commit diff
path: root/README.rst
diff options
context:
space:
mode:
authorDavid Baker <dbkr@matrix.org>2014-10-02 10:43:22 +0100
committerDavid Baker <dbkr@matrix.org>2014-10-02 10:43:22 +0100
commit7a322b63264acbef7e60b511ad8d39ae4718386b (patch)
treeddb43a27a8678030725e750e21f6b72944224d65 /README.rst
parentRe-apply a0b1b34c71e46304f7024f0570db92f4577303b5 to master (fixing synctl) (diff)
downloadsynapse-7a322b63264acbef7e60b511ad8d39ae4718386b.tar.xz
Update README setup instructions to be correct. Make synapse spit out explanatory note when generating config to tell people to look at it and customise it.
Diffstat (limited to '')
-rw-r--r--README.rst12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 6f7940e742..1530e5caac 100644
--- a/README.rst
+++ b/README.rst
@@ -46,11 +46,13 @@ To get up and running:
     - To simply play with an **existing** homeserver you can
       just go straight to http://matrix.org/alpha.
     
-    - To run your own **private** homeserver on localhost:8008, install synapse with
-      ``python setup.py develop --user`` and then run ``./synctl start`` twice (once to
-      generate a config; once to actually run) - you will find a webclient running at
-      http://localhost:8008. Please use a recent Chrome, Safari or Firefox for now...
-             
+    - To run your own **private** homeserver on localhost:8008, generate a basic
+      config file: ``./synctl start`` will give you instructions on how to do this.
+      Once you've done so, running ``./synctl start`` again will start your private
+      home sserver. You will find a webclient running at http://localhost:8008.
+      Please use a recent Chrome or Firefox for now (or Safari if you don't need
+      VoIP support).
+
     - To run a **public** homeserver and let it exchange messages with other homeservers
       and participate in the global Matrix federation, you must expose port 8448 to the
       internet and edit homeserver.yaml to specify server_name (the public DNS entry for