diff options
author | Patrick Cloke <clokep@users.noreply.github.com> | 2022-03-08 15:02:59 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-03-08 15:02:59 -0500 |
commit | 9a0172d49f3da46c615304c7df3353494500fd49 (patch) | |
tree | 067bd43f8c087df6f0c4f5d2c8eb056965fff500 /demo/README | |
parent | Use `ParamSpec` in type hints for `synapse.logging.context` (#12150) (diff) | |
download | synapse-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 'demo/README')
-rw-r--r-- | demo/README | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/demo/README b/demo/README deleted file mode 100644 index a5a95bd196..0000000000 --- a/demo/README +++ /dev/null @@ -1,26 +0,0 @@ -DO NOT USE THESE DEMO SERVERS IN PRODUCTION - -Requires you to have done: - python setup.py develop - - -The demo start.sh will start three synapse servers on ports 8080, 8081 and 8082, with host names localhost:$port. This can be easily changed to `hostname`:$port in start.sh if required. - -To enable the servers to communicate untrusted ssl certs are used. In order to do this the servers do not check the certs -and are configured in a highly insecure way. Do not use these configuration files in production. - -stop.sh will stop the synapse servers and the webclient. - -clean.sh will delete the databases and log files. - -To start a completely new set of servers, run: - - ./demo/stop.sh; ./demo/clean.sh && ./demo/start.sh - - -Logs and sqlitedb will be stored in demo/808{0,1,2}.{log,db} - - - -Also note that when joining a public room on a different HS via "#foo:bar.net", then you are (in the current impl) joining a room with room_id "foo". This means that it won't work if your HS already has a room with that name. - |