summary refs log tree commit diff
path: root/docs/SUMMARY.md
blob: 9af7d006c079729de3914154f84e9818570e53f7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# Summary

# Introduction
- [Welcome and Overview](introduction/welcome_and_overview.md)

# Setup
  - [Installation](setup/installation.md)
  - [Using Postgres](setup/postgres.md)
  - [Configuring a Reverse Proxy](setup/reverse_proxy.md)
  - [Configuring a Forward/Outbound Proxy](setup/forward_proxy.md)
  - [Configuring a Turn Server](setup/turn-howto.md)
  - [Delegation](setup/delegation.md)

# Upgrading
  - [Upgrading between Synapse Versions](upgrade.md)
  - [Upgrading from pre-Synapse 1.0](upgrading/upgrading_from_pre_synapse_1.0.md)

# Usage
  - [Federation](usage/federation/README.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](usage/configuration/structured_logging.md)
    - [Templates](usage/configuration/templates.md)
    - [User Authentication](usage/configuration/user_authentication/README.md)
      - [Single-Sign On](usage/configuration/user_authentication/single_sign_on/README.md)
        - [OpenID Connect](usage/configuration/user_authentication/single_sign_on/openid.md)
        - [SAML](usage/configuration/user_authentication/single_sign_on/saml.md)
        - [CAS](usage/configuration/user_authentication/single_sign_on/cas.md)
        - [SSO Mapping Providers](usage/configuration/user_authentication/single_sign_on/sso_mapping_providers.md)
      - [Password Auth Providers](usage/configuration/user_authentication/password_auth_providers.md)
      - [JSON Web Tokens](usage/configuration/json_web_tokens.md)
    - [Registration Captcha](usage/configuration/registration_captcha.md)
    - [Application Services](usage/configuration/application_services.md)
    - [Server Notices](usage/configuration/server_notices.md)
    - [Consent Tracking](usage/configuration/consent_tracking.md)
    - [URL Previews](development/url_previews.md)
    - [User Directory](usage/configuration/user_directory.md)
    - [Message Retention Policies](usage/configuration/message_retention_policies.md)
    - [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)
        - [Password auth provider callbacks](modules/password_auth_provider_callbacks.md)
        - [Porting a legacy module to the new interface](modules/porting_legacy_module.md)
    - [Workers](usage/configuration/workers/README.md)
      - [Using `synctl` with Workers](usage/configuration/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)
      - [Background Updates](usage/administration/admin_api/background_updates.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)
      - [Registration Tokens](usage/administration/admin_api/registration_tokens.md)
      - [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](usage/administration/manhole.md)
    - [Monitoring](usage/administration/monitoring.md)
    - [Request log format](usage/administration/request_log.md)
    - [Scripts]()

# Development
  - [Contributing Guide](development/contributing_guide.md)
  - [Code Style](development/code_style.md)
  - [Git Usage](development/git.md)
  - [Testing]()
  - [OpenTracing](development/opentracing.md)
  - [Database Schemas](development/database_schema.md)
  - [Experimental features](development/experimental_features.md)
  - [Synapse Architecture]()
    - [Log Contexts](development/synapse_architecture/log_contexts.md)
    - [Replication](development/synapse_architecture/replication.md)
    - [TCP Replication](development/synapse_architecture/tcp_replication.md)
  - [Internal Documentation](development/internal_documentation/README.md)
    - [Single Sign-On]()
      - [SAML](development/saml.md)
      - [CAS](development/cas.md)
    - [Room DAG concepts](development/room-dag-concepts.md)
    - [State Resolution]()
      - [The Auth Chain Difference Algorithm](development/internal_documentation/state_resolution/auth_chain_difference_algorithm.md)
    - [Media Repository](development/internal_documentation/media_repository.md)
    - [Room and User Statistics](development/internal_documentation/room_and_user_statistics.md)
  - [Scripts]()

# Other
  - [Dependency Deprecation Policy](other/dependency_deprecation_policy.md)