Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.

This commit is contained in:
David Baker 2014-10-02 10:43:22 +01:00
parent d1adb19b8a
commit 7a322b6326
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -46,10 +46,12 @@ To get up and running:
- To simply play with an **existing** homeserver you can - To simply play with an **existing** homeserver you can
just go straight to http://matrix.org/alpha. just go straight to http://matrix.org/alpha.
- To run your own **private** homeserver on localhost:8008, install synapse with - To run your own **private** homeserver on localhost:8008, generate a basic
``python setup.py develop --user`` and then run ``./synctl start`` twice (once to config file: ``./synctl start`` will give you instructions on how to do this.
generate a config; once to actually run) - you will find a webclient running at Once you've done so, running ``./synctl start`` again will start your private
http://localhost:8008. Please use a recent Chrome, Safari or Firefox for now... 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 - 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 and participate in the global Matrix federation, you must expose port 8448 to the

1
synapse/config/_base.py
View File

@ -123,6 +123,7 @@ class Config(object):
# style mode markers into the file, to hint to people that # style mode markers into the file, to hint to people that
# this is a YAML file. # this is a YAML file.
yaml.dump(config, config_file, default_flow_style=False) 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'])
sys.exit(0) sys.exit(0)
return cls(args) return cls(args)