summary refs log tree commit diff
path: root/README.rst
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2022-03-08 15:02:59 -0500
committerGitHub <noreply@github.com>2022-03-08 15:02:59 -0500
commit9a0172d49f3da46c615304c7df3353494500fd49 (patch)
tree067bd43f8c087df6f0c4f5d2c8eb056965fff500 /README.rst
parentUse `ParamSpec` in type hints for `synapse.logging.context` (#12150) (diff)
downloadsynapse-9a0172d49f3da46c615304c7df3353494500fd49.tar.xz
Clean-up demo scripts & documentation (#12143)
* Rewrites the demo documentation to be clearer, accurate, and moves it to our documentation tree.
* Improvements to the demo scripts:
	* `clean.sh` now runs `stop.sh` first to avoid zombie processes.
	* Uses more modern Synapse configuration (and removes some obsolete configuration).
	* Consistently use the HTTP ports for server name, etc.
	* Remove the `demo/etc` directory and place everything into the `demo/808x` directories.
Diffstat (limited to '')
-rw-r--r--README.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 4281c87d1f..595fb5ff62 100644
--- a/README.rst
+++ b/README.rst
@@ -312,6 +312,9 @@ We recommend using the demo which starts 3 federated instances running on ports
 
 (to stop, you can use `./demo/stop.sh`)
 
+See the [demo documentation](https://matrix-org.github.io/synapse/develop/development/demo.html)
+for more information.
+
 If you just want to start a single instance of the app and run it directly::
 
     # Create the homeserver.yaml config once