diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/README.rst b/README.rst index cfdc2a1c75..2d355d9649 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ -Quick Start -=========== +Introduction +============ Matrix is an ambitious new ecosystem for open federated Instant Messaging and VoIP[1]. The basics you need to know to get up and running are: @@ -17,6 +17,9 @@ The overall architecture is:: client <----> homeserver <=================> homeserver <-----> client e.g. matrix.org:8080 e.g. mydomain.net:8080 +Quick Start +=========== + To get up and running: - To simply play with an **existing** homeserver you can @@ -173,7 +176,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 +193,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. |