1. Introduction
  2. Welcome and Overview
  3. Setup
  4. Installation
  5. Security
  6. Using Postgres
  7. Configuring a Reverse Proxy
  8. Configuring a Forward/Outbound Proxy
  9. Configuring a Turn Server
    1. coturn TURN server
    2. eturnal TURN server
  10. Delegation
  11. Upgrading
  12. Upgrading between Synapse Versions
  13. Usage
  14. Federation
  15. Configuration
    1. Configuration Manual
    2. Homeserver Sample Config File
    3. Logging Sample Config File
    4. Structured Logging
    5. Templates
    6. User Authentication
      1. Single-Sign On
        1. OpenID Connect
        2. SAML
        3. CAS
        4. SSO Mapping Providers
      2. Password Auth Providers
      3. JSON Web Tokens
      4. Refresh Tokens
    7. Registration Captcha
    8. Application Services
    9. Server Notices
    10. Consent Tracking
    11. User Directory
    12. Message Retention Policies
    13. Pluggable Modules
      1. Writing a module
        1. Spam checker callbacks
        2. Third-party rules callbacks
        3. Presence router callbacks
        4. Account validity callbacks
        5. Password auth provider callbacks
        6. Background update controller callbacks
        7. Account data callbacks
        8. Add extra fields to client events unsigned section callbacks
        9. Media repository callbacks
        10. Ratelimit callbacks
        11. Porting a legacy module to the new interface
    14. Workers
      1. Using synctl with Workers
      2. Systemd
  16. Administration
    1. Backups
    2. Admin API
      1. Account Validity
      2. Background Updates
      3. Fetch Event
      4. Event Reports
      5. Experimental Features
      6. Media
      7. Purge History
      8. Register Users
      9. Registration Tokens
      10. Manipulate Room Membership
      11. Rooms
      12. Scheduled tasks
      13. Server Notices
      14. Statistics
      15. Users
      16. Server Version
      17. Federation
      18. Client-Server API Extensions
    3. Manhole
    4. Monitoring
      1. Reporting Homeserver Usage Statistics
    5. Monthly Active Users
    6. Understanding Synapse Through Grafana Graphs
    7. Useful SQL for Admins
    8. Database Maintenance Tools
    9. State Groups
    10. Request log format
    11. Admin FAQ
    12. Scripts
  17. Development
  18. Contributing Guide
  19. Code Style
  20. Reviewing Code
  21. Release Cycle
  22. Git Usage
  23. Testing
    1. Demo scripts
  24. OpenTracing
  25. Database Schemas
  26. Experimental features
  27. Dependency management
  28. Synapse Architecture
    1. Cancellation
    2. Log Contexts
    3. Replication
    4. Streams
    5. TCP Replication
    6. Faster remote joins
  29. Internal Documentation
    1. Single Sign-On
      1. SAML
      2. CAS
    2. Room DAG concepts
    3. State Resolution
      1. The Auth Chain Difference Algorithm
    4. Media Repository
    5. Room and User Statistics
    6. Releasing
      1. Release Notes Review Checklist
  30. Scripts
  31. Other
  32. Dependency Deprecation Policy
  33. Running Synapse on a Single-Board Computer