2021-06-03 12:20:40 -04:00
|
|
|
# Summary
|
|
|
|
|
|
|
|
|
|
# Introduction
|
|
|
|
|
- [Welcome and Overview](welcome_and_overview.md)
|
|
|
|
|
|
|
|
|
|
# Setup
|
|
|
|
|
- [Installation](setup/installation.md)
|
|
|
|
|
- [Using Postgres](postgres.md)
|
|
|
|
|
- [Configuring a Reverse Proxy](reverse_proxy.md)
|
2021-08-05 07:20:05 -04:00
|
|
|
- [Configuring a Forward/Outbound Proxy](setup/forward_proxy.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [Configuring a Turn Server](turn-howto.md)
|
|
|
|
|
- [Delegation](delegate.md)
|
|
|
|
|
|
|
|
|
|
# Upgrading
|
2021-06-23 11:57:57 -04:00
|
|
|
- [Upgrading between Synapse Versions](upgrade.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [Upgrading from pre-Synapse 1.0](MSC1711_certificates_FAQ.md)
|
|
|
|
|
|
|
|
|
|
# Usage
|
|
|
|
|
- [Federation](federate.md)
|
|
|
|
|
- [Configuration](usage/configuration/README.md)
|
|
|
|
|
- [Homeserver Sample Config File](usage/configuration/homeserver_sample_config.md)
|
|
|
|
|
- [Logging Sample Config File](usage/configuration/logging_sample_config.md)
|
|
|
|
|
- [Structured Logging](structured_logging.md)
|
2021-08-17 08:45:24 -04:00
|
|
|
- [Templates](templates.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [User Authentication](usage/configuration/user_authentication/README.md)
|
|
|
|
|
- [Single-Sign On]()
|
|
|
|
|
- [OpenID Connect](openid.md)
|
|
|
|
|
- [SAML]()
|
|
|
|
|
- [CAS]()
|
|
|
|
|
- [SSO Mapping Providers](sso_mapping_providers.md)
|
|
|
|
|
- [Password Auth Providers](password_auth_providers.md)
|
|
|
|
|
- [JSON Web Tokens](jwt.md)
|
|
|
|
|
- [Registration Captcha](CAPTCHA_SETUP.md)
|
|
|
|
|
- [Application Services](application_services.md)
|
|
|
|
|
- [Server Notices](server_notices.md)
|
|
|
|
|
- [Consent Tracking](consent_tracking.md)
|
2021-09-07 09:10:34 -04:00
|
|
|
- [URL Previews](development/url_previews.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [User Directory](user_directory.md)
|
|
|
|
|
- [Message Retention Policies](message_retention_policies.md)
|
2021-09-08 13:14:54 -04:00
|
|
|
- [Pluggable Modules](modules/index.md)
|
|
|
|
|
- [Writing a module](modules/writing_a_module.md)
|
|
|
|
|
- [Spam checker callbacks](modules/spam_checker_callbacks.md)
|
|
|
|
|
- [Third-party rules callbacks](modules/third_party_rules_callbacks.md)
|
|
|
|
|
- [Presence router callbacks](modules/presence_router_callbacks.md)
|
|
|
|
|
- [Account validity callbacks](modules/account_validity_callbacks.md)
|
|
|
|
|
- [Porting a legacy module to the new interface](modules/porting_legacy_module.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [Workers](workers.md)
|
|
|
|
|
- [Using `synctl` with Workers](synctl_workers.md)
|
|
|
|
|
- [Systemd](systemd-with-workers/README.md)
|
|
|
|
|
- [Administration](usage/administration/README.md)
|
|
|
|
|
- [Admin API](usage/administration/admin_api/README.md)
|
|
|
|
|
- [Account Validity](admin_api/account_validity.md)
|
|
|
|
|
- [Delete Group](admin_api/delete_group.md)
|
|
|
|
|
- [Event Reports](admin_api/event_reports.md)
|
|
|
|
|
- [Media](admin_api/media_admin_api.md)
|
|
|
|
|
- [Purge History](admin_api/purge_history_api.md)
|
|
|
|
|
- [Register Users](admin_api/register_api.md)
|
2021-08-21 17:14:43 -04:00
|
|
|
- [Registration Tokens](usage/administration/admin_api/registration_tokens.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [Manipulate Room Membership](admin_api/room_membership.md)
|
|
|
|
|
- [Rooms](admin_api/rooms.md)
|
|
|
|
|
- [Server Notices](admin_api/server_notices.md)
|
|
|
|
|
- [Statistics](admin_api/statistics.md)
|
|
|
|
|
- [Users](admin_api/user_admin_api.md)
|
|
|
|
|
- [Server Version](admin_api/version_api.md)
|
|
|
|
|
- [Manhole](manhole.md)
|
|
|
|
|
- [Monitoring](metrics-howto.md)
|
2021-06-16 08:31:55 -04:00
|
|
|
- [Request log format](usage/administration/request_log.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [Scripts]()
|
|
|
|
|
|
|
|
|
|
# Development
|
|
|
|
|
- [Contributing Guide](development/contributing_guide.md)
|
|
|
|
|
- [Code Style](code_style.md)
|
2021-07-22 06:58:24 -04:00
|
|
|
- [Git Usage](development/git.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [Testing]()
|
|
|
|
|
- [OpenTracing](opentracing.md)
|
2021-06-11 09:45:53 -04:00
|
|
|
- [Database Schemas](development/database_schema.md)
|
2021-09-22 09:41:42 -04:00
|
|
|
- [Experimental features](development/experimental_features.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [Synapse Architecture]()
|
|
|
|
|
- [Log Contexts](log_contexts.md)
|
|
|
|
|
- [Replication](replication.md)
|
|
|
|
|
- [TCP Replication](tcp_replication.md)
|
|
|
|
|
- [Internal Documentation](development/internal_documentation/README.md)
|
|
|
|
|
- [Single Sign-On]()
|
2021-07-22 06:58:24 -04:00
|
|
|
- [SAML](development/saml.md)
|
|
|
|
|
- [CAS](development/cas.md)
|
2021-08-03 06:08:57 -04:00
|
|
|
- [Room DAG concepts](development/room-dag-concepts.md)
|
2021-06-03 12:20:40 -04:00
|
|
|
- [State Resolution]()
|
|
|
|
|
- [The Auth Chain Difference Algorithm](auth_chain_difference_algorithm.md)
|
|
|
|
|
- [Media Repository](media_repository.md)
|
|
|
|
|
- [Room and User Statistics](room_and_user_statistics.md)
|
|
|
|
|
- [Scripts]()
|
|
|
|
|
|
|
|
|
|
# Other
|
2021-06-11 09:45:53 -04:00
|
|
|
- [Dependency Deprecation Policy](deprecation_policy.md)
|
