synapse/develop/toc.html

<!DOCTYPE HTML>
<html lang="en" class="light" dir="ltr">
    <head>
        <!-- sidebar iframe generated using mdBook

        This is a frame, and not included directly in the page, to control the total size of the
        book. The TOC contains an entry for each page, so if each page includes a copy of the TOC,
        the total size of the page becomes O(n**2).

        The frame is only used as a fallback when JS is turned off. When it's on, the sidebar is
        instead added to the main page by `toc.js` instead. The JavaScript mode is better
        because, when running in a `file:///` URL, the iframed page would not be Same-Origin as
        the rest of the page, so the sidebar and the main page theme would fall out of sync.
        -->
        <meta charset="UTF-8">
        <meta name="robots" content="noindex">
        <!-- Custom HTML head -->
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta name="theme-color" content="#ffffff">
        <link rel="stylesheet" href="css/variables-8adf115d.css">
        <link rel="stylesheet" href="css/general-2459343d.css">
        <link rel="stylesheet" href="css/chrome-ae938929.css">
        <link rel="stylesheet" href="css/print-9e4910d8.css" media="print">
        <!-- Fonts -->
        <link rel="stylesheet" href="fonts/fonts-9644e21d.css">
        <!-- Custom theme stylesheets -->
        <link rel="stylesheet" href="docs/website_files/indent-section-headers-3390f960.css">
        <link rel="stylesheet" href="docs/website_files/version-picker-ddc5216e.css">
    </head>
    <body class="sidebar-iframe-inner">
        <ol class="chapter"><li class="chapter-item expanded "><li class="part-title">Introduction</li></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="welcome_and_overview.html" target="_parent">Welcome and Overview</a></span></li><li class="chapter-item expanded "><li class="part-title">Setup</li></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="setup/installation.html" target="_parent">Installation</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="setup/security.html" target="_parent">Security</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="postgres.html" target="_parent">Using Postgres</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="reverse_proxy.html" target="_parent">Configuring a Reverse Proxy</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="setup/forward_proxy.html" target="_parent">Configuring a Forward/Outbound Proxy</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="turn-howto.html" target="_parent">Configuring a Turn Server</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="setup/turn/coturn.html" target="_parent">coturn TURN server</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="setup/turn/eturnal.html" target="_parent">eturnal TURN server</a></span></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="delegate.html" target="_parent">Delegation</a></span></li><li class="chapter-item expanded "><li class="part-title">Upgrading</li></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="upgrade.html" target="_parent">Upgrading between Synapse Versions</a></span></li><li class="chapter-item expanded "><li class="part-title">Usage</li></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="federate.html" target="_parent">Federation</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/configuration/index.html" target="_parent">Configuration</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/configuration/config_documentation.html" target="_parent">Configuration Manual</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/configuration/homeserver_sample_config.html" target="_parent">Homeserver Sample Config File</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/configuration/logging_sample_config.html" target="_parent">Logging Sample Config File</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="structured_logging.html" target="_parent">Structured Logging</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="templates.html" target="_parent">Templates</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/configuration/user_authentication/index.html" target="_parent">User Authentication</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/configuration/user_authentication/single_sign_on/index.html" target="_parent">Single-Sign On</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="openid.html" target="_parent">OpenID Connect</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/configuration/user_authentication/single_sign_on/saml.html" target="_parent">SAML</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/configuration/user_authentication/single_sign_on/cas.html" target="_parent">CAS</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="sso_mapping_providers.html" target="_parent">SSO Mapping Providers</a></span></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="password_auth_providers.html" target="_parent">Password Auth Providers</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="jwt.html" target="_parent">JSON Web Tokens</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/configuration/user_authentication/refresh_tokens.html" target="_parent">Refresh Tokens</a></span></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="CAPTCHA_SETUP.html" target="_parent">Registration Captcha</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="application_services.html" target="_parent">Application Services</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="server_notices.html" target="_parent">Server Notices</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="consent_tracking.html" target="_parent">Consent Tracking</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="user_directory.html" target="_parent">User Directory</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="message_retention_policies.html" target="_parent">Message Retention Policies</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/index.html" target="_parent">Pluggable Modules</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/writing_a_module.html" target="_parent">Writing a module</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/spam_checker_callbacks.html" target="_parent">Spam checker callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/third_party_rules_callbacks.html" target="_parent">Third-party rules callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/presence_router_callbacks.html" target="_parent">Presence router callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/account_validity_callbacks.html" target="_parent">Account validity callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/password_auth_provider_callbacks.html" target="_parent">Password auth provider callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/background_update_controller_callbacks.html" target="_parent">Background update controller callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/account_data_callbacks.html" target="_parent">Account data callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/add_extra_fields_to_client_events_unsigned.html" target="_parent">Add extra fields to client events unsigned section callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/media_repository_callbacks.html" target="_parent">Media repository callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/ratelimit_callbacks.html" target="_parent">Ratelimit callbacks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="modules/porting_legacy_module.html" target="_parent">Porting a legacy module to the new interface</a></span></li></ol></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="workers.html" target="_parent">Workers</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="synctl_workers.html" target="_parent">Using synctl with Workers</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="systemd-with-workers/index.html" target="_parent">Systemd</a></span></li></ol></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/index.html" target="_parent">Administration</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/backups.html" target="_parent">Backups</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/admin_api/index.html" target="_parent">Admin API</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/account_validity.html" target="_parent">Account Validity</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/admin_api/background_updates.html" target="_parent">Background Updates</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/fetch_event.html" target="_parent">Fetch Event</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/event_reports.html" target="_parent">Event Reports</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/experimental_features.html" target="_parent">Experimental Features</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/media_admin_api.html" target="_parent">Media</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/purge_history_api.html" target="_parent">Purge History</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/register_api.html" target="_parent">Register Users</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/admin_api/registration_tokens.html" target="_parent">Registration Tokens</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/room_membership.html" target="_parent">Manipulate Room Membership</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/rooms.html" target="_parent">Rooms</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/scheduled_tasks.html" target="_parent">Scheduled tasks</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/server_notices.html" target="_parent">Server Notices</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/statistics.html" target="_parent">Statistics</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/user_admin_api.html" target="_parent">Users</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/version_api.html" target="_parent">Server Version</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/admin_api/federation.html" target="_parent">Federation</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="admin_api/client_server_api_extensions.html" target="_parent">Client-Server API Extensions</a></span></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="manhole.html" target="_parent">Manhole</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="metrics-howto.html" target="_parent">Monitoring</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/monitoring/reporting_homeserver_usage_statistics.html" target="_parent">Reporting Homeserver Usage Statistics</a></span></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/monthly_active_users.html" target="_parent">Monthly Active Users</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/understanding_synapse_through_grafana_graphs.html" target="_parent">Understanding Synapse Through Grafana Graphs</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/useful_sql_for_admins.html" target="_parent">Useful SQL for Admins</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/database_maintenance_tools.html" target="_parent">Database Maintenance Tools</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/state_groups.html" target="_parent">State Groups</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/request_log.html" target="_parent">Request log format</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="usage/administration/admin_faq.html" target="_parent">Admin FAQ</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><span>Scripts</span></span></li></ol><li class="chapter-item expanded "><li class="part-title">Development</li></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/contributing_guide.html" target="_parent">Contributing Guide</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="code_style.html" target="_parent">Code Style</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/reviews.html" target="_parent">Reviewing Code</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/releases.html" target="_parent">Release Cycle</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/git.html" target="_parent">Git Usage</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><span>Testing</span></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/demo.html" target="_parent">Demo scripts</a></span></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="opentracing.html" target="_parent">OpenTracing</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/database_schema.html" target="_parent">Database Schemas</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/experimental_features.html" target="_parent">Experimental features</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/dependencies.html" target="_parent">Dependency management</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><span>Synapse Architecture</span></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/synapse_architecture/cancellation.html" target="_parent">Cancellation</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="log_contexts.html" target="_parent">Log Contexts</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="replication.html" target="_parent">Replication</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/synapse_architecture/streams.html" target="_parent">Streams</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="tcp_replication.html" target="_parent">TCP Replication</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/synapse_architecture/faster_joins.html" target="_parent">Faster remote joins</a></span></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/internal_documentation/index.html" target="_parent">Internal Documentation</a></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><span>Single Sign-On</span></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/saml.html" target="_parent">SAML</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/cas.html" target="_parent">CAS</a></span></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/room-dag-concepts.html" target="_parent">Room DAG concepts</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><span>State Resolution</span></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="auth_chain_difference_algorithm.html" target="_parent">The Auth Chain Difference Algorithm</a></span></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="media_repository.html" target="_parent">Media Repository</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="room_and_user_statistics.html" target="_parent">Room and User Statistics</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><span>Releasing</span></span><ol class="section"><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="development/internal_documentation/release_notes_review_checklist.html" target="_parent">Release Notes Review Checklist</a></span></li></ol></li></ol><li class="chapter-item expanded "><span class="chapter-link-wrapper"><span>Scripts</span></span></li><li class="chapter-item expanded "><li class="part-title">Other</li></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="deprecation_policy.html" target="_parent">Dependency Deprecation Policy</a></span></li><li class="chapter-item expanded "><span class="chapter-link-wrapper"><a href="other/running_synapse_on_single_board_computers.html" target="_parent">Running Synapse on a Single-Board Computer</a></span></li></ol>
    </body>
</html>