From 48db13c6fd806f3f68f121d270e0182e1106e73d Mon Sep 17 00:00:00 2001 From: clokep Date: Tue, 8 Mar 2022 20:03:34 +0000 Subject: deploy: 9a0172d49f3da46c615304c7df3353494500fd49 --- develop/404.html | 2 +- develop/CAPTCHA_SETUP.html | 2 +- develop/admin_api/account_validity.html | 2 +- develop/admin_api/delete_group.html | 2 +- develop/admin_api/event_reports.html | 2 +- develop/admin_api/media_admin_api.html | 2 +- develop/admin_api/purge_history_api.html | 2 +- develop/admin_api/register_api.html | 2 +- develop/admin_api/room_membership.html | 2 +- develop/admin_api/rooms.html | 2 +- develop/admin_api/server_notices.html | 2 +- develop/admin_api/statistics.html | 2 +- develop/admin_api/user_admin_api.html | 2 +- develop/admin_api/version_api.html | 2 +- develop/application_services.html | 2 +- develop/auth_chain_difference_algorithm.html | 2 +- develop/code_style.html | 2 +- develop/consent_tracking.html | 2 +- develop/delegate.html | 2 +- develop/deprecation_policy.html | 2 +- develop/development/cas.html | 2 +- develop/development/contributing_guide.html | 2 +- develop/development/database_schema.html | 2 +- develop/development/demo.html | 289 +++++++++++++++++++++ develop/development/experimental_features.html | 2 +- develop/development/git.html | 6 +- .../development/internal_documentation/index.html | 2 +- develop/development/releases.html | 2 +- develop/development/room-dag-concepts.html | 2 +- develop/development/saml.html | 2 +- develop/development/url_previews.html | 2 +- develop/federate.html | 5 +- develop/index.html | 2 +- develop/jwt.html | 2 +- develop/log_contexts.html | 2 +- develop/manhole.html | 2 +- develop/media_repository.html | 2 +- develop/message_retention_policies.html | 2 +- develop/metrics-howto.html | 2 +- develop/modules/account_validity_callbacks.html | 2 +- .../background_update_controller_callbacks.html | 2 +- develop/modules/index.html | 2 +- .../modules/password_auth_provider_callbacks.html | 2 +- develop/modules/porting_legacy_module.html | 2 +- develop/modules/presence_router_callbacks.html | 2 +- develop/modules/spam_checker_callbacks.html | 2 +- develop/modules/third_party_rules_callbacks.html | 2 +- develop/modules/writing_a_module.html | 2 +- develop/openid.html | 2 +- develop/opentracing.html | 6 +- .../running_synapse_on_single_board_computers.html | 2 +- develop/password_auth_providers.html | 2 +- develop/postgres.html | 2 +- develop/print.html | 39 ++- develop/replication.html | 2 +- develop/reverse_proxy.html | 2 +- develop/room_and_user_statistics.html | 2 +- develop/searchindex.js | 2 +- develop/searchindex.json | 2 +- develop/server_notices.html | 2 +- develop/setup/forward_proxy.html | 2 +- develop/setup/installation.html | 2 +- develop/sso_mapping_providers.html | 2 +- develop/structured_logging.html | 2 +- develop/synctl_workers.html | 2 +- develop/systemd-with-workers/index.html | 2 +- develop/tcp_replication.html | 2 +- develop/templates.html | 2 +- develop/turn-howto.html | 2 +- develop/upgrade.html | 2 +- .../admin_api/background_updates.html | 2 +- .../usage/administration/admin_api/federation.html | 2 +- develop/usage/administration/admin_api/index.html | 2 +- .../admin_api/registration_tokens.html | 2 +- develop/usage/administration/admin_faq.html | 2 +- .../administration/database_maintenance_tools.html | 2 +- develop/usage/administration/index.html | 2 +- develop/usage/administration/request_log.html | 2 +- develop/usage/administration/state_groups.html | 2 +- ...derstanding_synapse_through_grafana_graphs.html | 2 +- .../administration/useful_sql_for_admins.html | 2 +- .../configuration/homeserver_sample_config.html | 2 +- develop/usage/configuration/index.html | 2 +- .../usage/configuration/logging_sample_config.html | 2 +- .../configuration/user_authentication/index.html | 2 +- .../user_authentication/refresh_tokens.html | 2 +- .../user_authentication/single_sign_on/cas.html | 2 +- .../user_authentication/single_sign_on/index.html | 2 +- .../user_authentication/single_sign_on/saml.html | 2 +- develop/user_directory.html | 2 +- develop/welcome_and_overview.html | 2 +- develop/workers.html | 2 +- 92 files changed, 422 insertions(+), 97 deletions(-) create mode 100644 develop/development/demo.html diff --git a/develop/404.html b/develop/404.html index f7ce0f5740..60676a72be 100644 --- a/develop/404.html +++ b/develop/404.html @@ -101,7 +101,7 @@ diff --git a/develop/CAPTCHA_SETUP.html b/develop/CAPTCHA_SETUP.html index a59ecadc61..849f374b72 100644 --- a/develop/CAPTCHA_SETUP.html +++ b/develop/CAPTCHA_SETUP.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/account_validity.html b/develop/admin_api/account_validity.html index 5e11a1dc9e..a51b6c43b7 100644 --- a/develop/admin_api/account_validity.html +++ b/develop/admin_api/account_validity.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/delete_group.html b/develop/admin_api/delete_group.html index 2c92ad6973..8ffb218061 100644 --- a/develop/admin_api/delete_group.html +++ b/develop/admin_api/delete_group.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/event_reports.html b/develop/admin_api/event_reports.html index 25e947933b..0f67285217 100644 --- a/develop/admin_api/event_reports.html +++ b/develop/admin_api/event_reports.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html index 8131ee272c..928c29e1bb 100644 --- a/develop/admin_api/media_admin_api.html +++ b/develop/admin_api/media_admin_api.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/purge_history_api.html b/develop/admin_api/purge_history_api.html index 9923cf66b6..6c707fab3b 100644 --- a/develop/admin_api/purge_history_api.html +++ b/develop/admin_api/purge_history_api.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/register_api.html b/develop/admin_api/register_api.html index 96c1416a78..3172e0b432 100644 --- a/develop/admin_api/register_api.html +++ b/develop/admin_api/register_api.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/room_membership.html b/develop/admin_api/room_membership.html index 10c4d6c4ab..a1ff6d831d 100644 --- a/develop/admin_api/room_membership.html +++ b/develop/admin_api/room_membership.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/rooms.html b/develop/admin_api/rooms.html index ffc1cde891..9e2bf53daf 100644 --- a/develop/admin_api/rooms.html +++ b/develop/admin_api/rooms.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/server_notices.html b/develop/admin_api/server_notices.html index ff8359c067..f28ed91895 100644 --- a/develop/admin_api/server_notices.html +++ b/develop/admin_api/server_notices.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/statistics.html b/develop/admin_api/statistics.html index e5da7e586e..5b7dd111a6 100644 --- a/develop/admin_api/statistics.html +++ b/develop/admin_api/statistics.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html index 2187faa7e6..1f0a861437 100644 --- a/develop/admin_api/user_admin_api.html +++ b/develop/admin_api/user_admin_api.html @@ -99,7 +99,7 @@ diff --git a/develop/admin_api/version_api.html b/develop/admin_api/version_api.html index beb66b10c2..19dbbd0893 100644 --- a/develop/admin_api/version_api.html +++ b/develop/admin_api/version_api.html @@ -99,7 +99,7 @@ diff --git a/develop/application_services.html b/develop/application_services.html index b2b3d4491c..3608ef1594 100644 --- a/develop/application_services.html +++ b/develop/application_services.html @@ -99,7 +99,7 @@ diff --git a/develop/auth_chain_difference_algorithm.html b/develop/auth_chain_difference_algorithm.html index 5e3c591d52..3fa4c084f2 100644 --- a/develop/auth_chain_difference_algorithm.html +++ b/develop/auth_chain_difference_algorithm.html @@ -99,7 +99,7 @@ diff --git a/develop/code_style.html b/develop/code_style.html index 3baa0e7dd7..3edd05e0e8 100644 --- a/develop/code_style.html +++ b/develop/code_style.html @@ -99,7 +99,7 @@ diff --git a/develop/consent_tracking.html b/develop/consent_tracking.html index 860483b5a6..ebf03a4d78 100644 --- a/develop/consent_tracking.html +++ b/develop/consent_tracking.html @@ -99,7 +99,7 @@ diff --git a/develop/delegate.html b/develop/delegate.html index 2f919f36a1..2147edf2ee 100644 --- a/develop/delegate.html +++ b/develop/delegate.html @@ -99,7 +99,7 @@ diff --git a/develop/deprecation_policy.html b/develop/deprecation_policy.html index 737f1b945f..c2f92b2f46 100644 --- a/develop/deprecation_policy.html +++ b/develop/deprecation_policy.html @@ -99,7 +99,7 @@ diff --git a/develop/development/cas.html b/develop/development/cas.html index c5a0d9973a..b7c71304a3 100644 --- a/develop/development/cas.html +++ b/develop/development/cas.html @@ -99,7 +99,7 @@ diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index f7420d9bd4..2a34b44485 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -99,7 +99,7 @@ diff --git a/develop/development/database_schema.html b/develop/development/database_schema.html index 7e2cecc9d6..01e6dbe529 100644 --- a/develop/development/database_schema.html +++ b/develop/development/database_schema.html @@ -99,7 +99,7 @@ diff --git a/develop/development/demo.html b/develop/development/demo.html new file mode 100644 index 0000000000..7345070101 --- /dev/null +++ b/develop/development/demo.html @@ -0,0 +1,289 @@ + + + + + + Demo scripts - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+ +
+ +
+ +

Synapse demo setup

+

DO NOT USE THESE DEMO SERVERS IN PRODUCTION

+

Requires you to have a Synapse development environment setup.

+

The demo setup allows running three federation Synapse servers, with server +names localhost:8080, localhost:8081, and localhost:8082.

+

You can access them via any Matrix client over HTTP at localhost:8080, +localhost:8081, and localhost:8082 or over HTTPS at localhost:8480, +localhost:8481, and localhost:8482.

+

To enable the servers to communicate, self-signed SSL certificates are generated +and the servers are configured in a highly insecure way, including:

+
    +
  • Not checking certificates over federation.
    • +
  • Not verifying keys.
    • +
+

The servers are configured to store their data under demo/8080, demo/8081, and +demo/8082. This includes configuration, logs, SQLite databases, and media.

+

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.

+

Using the demo scripts

+

There's three main scripts with straightforward purposes:

+
    +
  • start.sh will start the Synapse servers, generating any missing configuration. +
      +
    • This accepts a single parameter --no-rate-limit to "disable" rate limits +(they actually still exist, but are very high).
      • +
    +
    • +
  • stop.sh will stop the Synapse servers.
    • +
  • clean.sh will delete the configuration, databases, log files, etc.
    • +
+

To start a completely new set of servers, run:

+
./demo/stop.sh; ./demo/clean.sh && ./demo/start.sh
+
+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/develop/development/experimental_features.html b/develop/development/experimental_features.html index 87e15ceb73..402e552d32 100644 --- a/develop/development/experimental_features.html +++ b/develop/development/experimental_features.html @@ -99,7 +99,7 @@ diff --git a/develop/development/git.html b/develop/development/git.html index 2960ab267a..e31c03e678 100644 --- a/develop/development/git.html +++ b/develop/development/git.html @@ -99,7 +99,7 @@ @@ -315,7 +315,7 @@ the history of Synapse), we've had two releases in flight at once. Obviously, - @@ -333,7 +333,7 @@ the history of Synapse), we've had two releases in flight at once. Obviously, - diff --git a/develop/development/internal_documentation/index.html b/develop/development/internal_documentation/index.html index d869fd373a..996acd6d62 100644 --- a/develop/development/internal_documentation/index.html +++ b/develop/development/internal_documentation/index.html @@ -99,7 +99,7 @@ diff --git a/develop/development/releases.html b/develop/development/releases.html index e73e6ba9a2..86041a1005 100644 --- a/develop/development/releases.html +++ b/develop/development/releases.html @@ -99,7 +99,7 @@ diff --git a/develop/development/room-dag-concepts.html b/develop/development/room-dag-concepts.html index 59cead08ab..ca29e721c8 100644 --- a/develop/development/room-dag-concepts.html +++ b/develop/development/room-dag-concepts.html @@ -99,7 +99,7 @@ diff --git a/develop/development/saml.html b/develop/development/saml.html index 49d9b4227b..218c3b550a 100644 --- a/develop/development/saml.html +++ b/develop/development/saml.html @@ -99,7 +99,7 @@ diff --git a/develop/development/url_previews.html b/develop/development/url_previews.html index e225fca096..85a72ebc72 100644 --- a/develop/development/url_previews.html +++ b/develop/development/url_previews.html @@ -99,7 +99,7 @@ diff --git a/develop/federate.html b/develop/federate.html index f3e8a062d7..f5efd3f0ab 100644 --- a/develop/federate.html +++ b/develop/federate.html @@ -99,7 +99,7 @@ @@ -233,7 +233,8 @@ release of Synapse.

Running a demo federation of Synapses

If you want to get up and running quickly with a trio of homeservers in a private federation, there is a script in the demo directory. This is mainly -useful just for development purposes. See demo/README.

+useful just for development purposes. See +demo scripts.

diff --git a/develop/index.html b/develop/index.html index 469f2d27dc..aacdf3e504 100644 --- a/develop/index.html +++ b/develop/index.html @@ -99,7 +99,7 @@ diff --git a/develop/jwt.html b/develop/jwt.html index 0764648fa6..9291bd821b 100644 --- a/develop/jwt.html +++ b/develop/jwt.html @@ -99,7 +99,7 @@ diff --git a/develop/log_contexts.html b/develop/log_contexts.html index a11eab427a..5b622cfc7e 100644 --- a/develop/log_contexts.html +++ b/develop/log_contexts.html @@ -99,7 +99,7 @@ diff --git a/develop/manhole.html b/develop/manhole.html index 1f1c273ee9..d318a6bb87 100644 --- a/develop/manhole.html +++ b/develop/manhole.html @@ -99,7 +99,7 @@ diff --git a/develop/media_repository.html b/develop/media_repository.html index b9f8d715a0..a8913c0855 100644 --- a/develop/media_repository.html +++ b/develop/media_repository.html @@ -99,7 +99,7 @@ diff --git a/develop/message_retention_policies.html b/develop/message_retention_policies.html index 6fb05be7dd..bf4dec4df5 100644 --- a/develop/message_retention_policies.html +++ b/develop/message_retention_policies.html @@ -99,7 +99,7 @@ diff --git a/develop/metrics-howto.html b/develop/metrics-howto.html index 9038fc4aa9..4590ea42aa 100644 --- a/develop/metrics-howto.html +++ b/develop/metrics-howto.html @@ -99,7 +99,7 @@ diff --git a/develop/modules/account_validity_callbacks.html b/develop/modules/account_validity_callbacks.html index 31096f12dd..dcfe9142d3 100644 --- a/develop/modules/account_validity_callbacks.html +++ b/develop/modules/account_validity_callbacks.html @@ -99,7 +99,7 @@ diff --git a/develop/modules/background_update_controller_callbacks.html b/develop/modules/background_update_controller_callbacks.html index 807959d819..285478947a 100644 --- a/develop/modules/background_update_controller_callbacks.html +++ b/develop/modules/background_update_controller_callbacks.html @@ -99,7 +99,7 @@ diff --git a/develop/modules/index.html b/develop/modules/index.html index dd3e4aa2bf..be3ce71bd9 100644 --- a/develop/modules/index.html +++ b/develop/modules/index.html @@ -99,7 +99,7 @@ diff --git a/develop/modules/password_auth_provider_callbacks.html b/develop/modules/password_auth_provider_callbacks.html index 768b702e26..21e8c4c587 100644 --- a/develop/modules/password_auth_provider_callbacks.html +++ b/develop/modules/password_auth_provider_callbacks.html @@ -99,7 +99,7 @@ diff --git a/develop/modules/porting_legacy_module.html b/develop/modules/porting_legacy_module.html index c905abcb5b..72c5b52a8f 100644 --- a/develop/modules/porting_legacy_module.html +++ b/develop/modules/porting_legacy_module.html @@ -99,7 +99,7 @@ diff --git a/develop/modules/presence_router_callbacks.html b/develop/modules/presence_router_callbacks.html index e82340ec1c..e715a63ca7 100644 --- a/develop/modules/presence_router_callbacks.html +++ b/develop/modules/presence_router_callbacks.html @@ -99,7 +99,7 @@ diff --git a/develop/modules/spam_checker_callbacks.html b/develop/modules/spam_checker_callbacks.html index c20d27d114..3ffd3b584b 100644 --- a/develop/modules/spam_checker_callbacks.html +++ b/develop/modules/spam_checker_callbacks.html @@ -99,7 +99,7 @@ diff --git a/develop/modules/third_party_rules_callbacks.html b/develop/modules/third_party_rules_callbacks.html index dc966fbdb8..4bc73a64a1 100644 --- a/develop/modules/third_party_rules_callbacks.html +++ b/develop/modules/third_party_rules_callbacks.html @@ -99,7 +99,7 @@ diff --git a/develop/modules/writing_a_module.html b/develop/modules/writing_a_module.html index a945d381ce..1a4027d4e8 100644 --- a/develop/modules/writing_a_module.html +++ b/develop/modules/writing_a_module.html @@ -99,7 +99,7 @@ diff --git a/develop/openid.html b/develop/openid.html index 8bb47d2620..c073c2a44a 100644 --- a/develop/openid.html +++ b/develop/openid.html @@ -99,7 +99,7 @@ diff --git a/develop/opentracing.html b/develop/opentracing.html index 0912ecc323..5dcbd74f21 100644 --- a/develop/opentracing.html +++ b/develop/opentracing.html @@ -99,7 +99,7 @@ @@ -261,7 +261,7 @@ logged to OpenTracing's logs.