summary refs log tree commit diff
path: root/README.rst
diff options
context:
space:
mode:
authorEric Eastwood <contact@ericeastwood.com>2021-01-15 05:58:31 -0600
committerGitHub <noreply@github.com>2021-01-15 06:58:31 -0500
commit20af310889ec1b22b5ad66cfd606bb25b264ec6a (patch)
tree9de10243bc923a5d8517d23a01b2bbafb3e84e32 /README.rst
parentMerge pull request #9091 from matrix-org/rav/error_on_bad_sso (diff)
downloadsynapse-20af310889ec1b22b5ad66cfd606bb25b264ec6a.tar.xz
Add some extra notes for getting Synapse running on macOS. (#8997)
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 9ff375708b..af914d71a8 100644
--- a/README.rst
+++ b/README.rst
@@ -280,6 +280,27 @@ differ)::
 
     PASSED (skips=15, successes=1322)
 
+We recommend using the demo which starts 3 federated instances running on ports `8080` - `8082`
+
+    ./demo/start.sh
+
+(to stop, you can use `./demo/stop.sh`)
+
+If you just want to start a single instance of the app and run it directly:
+
+    # Create the homeserver.yaml config once
+    python -m synapse.app.homeserver \
+      --server-name my.domain.name \
+      --config-path homeserver.yaml \
+      --generate-config \
+      --report-stats=[yes|no]
+
+    # Start the app
+    python -m synapse.app.homeserver --config-path homeserver.yaml
+
+
+
+
 Running the Integration Tests
 =============================