2. Introduction
  3. Welcome and Overview
  5. Setup
  6. Installation
  7. Using Postgres
  8. Configuring a Reverse Proxy
  9. Configuring a Forward/Outbound Proxy
  10. Configuring a Turn Server
    1. coturn TURN server
    2. eturnal TURN server
  12. Delegation
  14. Upgrading
  15. Upgrading between Synapse Versions
  17. Usage
  18. Federation
  19. 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
      3. Password Auth Providers
      4. JSON Web Tokens
      5. Refresh Tokens
    8. Registration Captcha
    9. Application Services
    10. Server Notices
    11. Consent Tracking
    12. User Directory
    13. Message Retention Policies
    14. 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
    16. Workers
      1. Using synctl with Workers
      2. Systemd
  21. 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. Modules
      17. Server Version
      18. Federation
      19. Client-Server API Extensions
    4. Manhole
    5. Monitoring
      1. Reporting Homeserver Usage Statistics
    7. Monthly Active Users
    8. Understanding Synapse Through Grafana Graphs
    9. Useful SQL for Admins
    10. Database Maintenance Tools
    11. State Groups
    12. Request log format
    13. Admin FAQ
    14. Scripts
  24. Development
  25. Contributing Guide
  26. Code Style
  27. Reviewing Code
  28. Release Cycle
  29. Git Usage
  30. Testing
    1. Demo scripts
  32. OpenTracing
  33. Database Schemas
  34. Experimental features
  35. Dependency management
  36. Synapse Architecture
    1. Cancellation
    2. Log Contexts
    3. Replication
    4. Streams
    5. TCP Replication
    6. Faster remote joins
  38. Internal Documentation
    1. Single Sign-On
      1. SAML
      2. CAS
    3. Room DAG concepts
    4. State Resolution
      1. The Auth Chain Difference Algorithm
    6. Media Repository
    7. Room and User Statistics
  40. Scripts
  42. Other
  43. Dependency Deprecation Policy
  44. Running Synapse on a Single-Board Computer