summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Baker <dbkr@matrix.org>2014-10-02 14:09:27 +0100
committerDavid Baker <dbkr@matrix.org>2014-10-02 14:09:27 +0100
commitd694619a953adf6254e3960d2a4ec973d31dfcae (patch)
tree378784559d4edbb9db279a83eb34362dc2adcb67
parentTrivial formatting fixes for README. (diff)
downloadsynapse-d694619a953adf6254e3960d2a4ec973d31dfcae.tar.xz
Fix ncorrect ports in documentation and add notes on how generate-config also generates certs bound to whatever hostname you give with --generate-config.
SYN-87 #resolved
-rw-r--r--README.rst5
-rw-r--r--synapse/config/_base.py3
-rwxr-xr-xsynctl2
3 files changed, 6 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 0459d54634..f40492b8a0 100644
--- a/README.rst
+++ b/README.rst
@@ -51,6 +51,7 @@ To get up and running:
 
 - 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.
+  For this purpose, you can use 'localhost' or your hostname as a server name.
   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
@@ -253,7 +254,7 @@ http://localhost:8080. Simply run::
 Running The Demo Web Client
 ===========================
 
-The homeserver runs a web client by default at http://localhost:8080.
+The homeserver runs a web client by default at https://localhost:8448/.
 
 If this is the first time you have used the client from that browser (it uses
 HTML5 local storage to remember its config), you will need to log in to your
@@ -273,7 +274,7 @@ account. Your name will take the form of::
 
 Specify your desired localpart in the topmost box of the "Register for an
 account" form, and click the "Register" button. Hostnames can contain ports if
-required due to lack of SRV records (e.g. @matthew:localhost:8080 on an
+required due to lack of SRV records (e.g. @matthew:localhost:8448 on an
 internal synapse sandbox running on localhost)
 
 
diff --git a/synapse/config/_base.py b/synapse/config/_base.py
index 809f9c922b..b3aeff327c 100644
--- a/synapse/config/_base.py
+++ b/synapse/config/_base.py
@@ -123,7 +123,8 @@ class Config(object):
                 #   style mode markers into the file, to hint to people that
                 #   this is a YAML file.
                 yaml.dump(config, config_file, default_flow_style=False)
-            print "A config file has been generated in %s (your server name is '%s'). Please review this file and customise it to your needs." % (config_args.config_path, config['server_name'])
+            print "A config file has been generated in %s for server name '%s') with corresponding SSL keys and self-signed certificates. Please review this file and customise it to your needs." % (config_args.config_path, config['server_name'])
+            print "If this server name is incorrect, you will need to regenerate the SSL certificates"
             sys.exit(0)
 
         return cls(args)
diff --git a/synctl b/synctl
index 7523fd3dbc..c227a9e1e4 100755
--- a/synctl
+++ b/synctl
@@ -14,7 +14,7 @@ case "$1" in
   start)
     if [ ! -f "$CONFIGFILE" ]; then
       echo "No config file found"
-      echo "To generate a config file, run '$SYNAPSE -c $CONFIGFILE --generate-config'"
+      echo "To generate a config file, run '$SYNAPSE -c $CONFIGFILE --generate-config --server-name=<server name>'"
       exit 1
     fi