summary refs log tree commit diff
path: root/UPGRADE.rst
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2014-09-02 17:06:08 +0100
committerErik Johnston <erik@matrix.org>2014-09-02 17:06:08 +0100
commit731c33dd97f193bd27bd28510b64b42f214da48f (patch)
tree041d31e99d9486cb8269fcf281c89e22314f1113 /UPGRADE.rst
parentFix spelling (diff)
downloadsynapse-731c33dd97f193bd27bd28510b64b42f214da48f.tar.xz
Don't so heavily suggest you need to edit the default config. List the changed parameters.
Diffstat (limited to '')
-rw-r--r--UPGRADE.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/UPGRADE.rst b/UPGRADE.rst
index d579383474..6083a5a326 100644
--- a/UPGRADE.rst
+++ b/UPGRADE.rst
@@ -7,7 +7,7 @@ To upgrade the database schema, run::
 
 
 The home server now requires setting up of SSL config before it can run. To
-automatically generate some default config that can be edited use::
+automatically generate the default config use::
 
     $ python synapse/app/homeserver.py \
         --server-name machine.my.domain.name \
@@ -15,13 +15,17 @@ automatically generate some default config that can be edited use::
         --config-path homeserver.config \
         --generate-config
 
-After editing the config, you can run the home server using::
+This config can be edited if desired, for example to specify a different SSL 
+certificate to use. Once done you can run the home server using::
 
     $ python synapse/app/homeserver.py --config-path homeserver.config
 
 See the README.rst for more information.
 
-Also note that many config options have been renamed.
+Also note that many config options have been renamed, including:
+ - "host" to "server-name"
+ - "database" to "database-path"
+ - "port" to "bind-port" and "unsecure-port"
 
 
 Upgrading to v0.0.1