tileradotorg/synapse

forked from MirrorHub/synapse

Andrew Morgan 7f25d73859

Convert UPGRADE.rst to markdown (#10166 )

This PR:

* Converts UPGRADE.rst to markdown and moves the contents into the `docs/` directory.
* Updates the contents of UPGRADE.rst to point to the website instead.
* Updates links around the codebase that point to UPGRADE.rst.

`pandoc` + some manual editing was used to convert from RST to md.

2021-06-23 16:57:57 +01:00

3.5 KiB

Raw Blame History

Summary

Introduction

Welcome and Overview

Setup

Upgrading

Usage

Federation
Configuration
- Homeserver Sample Config File
- Logging Sample Config File
- Structured Logging
- User Authentication
  - Single-Sign On
    - OpenID Connect
    - SAML
    - CAS
    - SSO Mapping Providers
  - Password Auth Providers
  - JSON Web Tokens
- Registration Captcha
- Application Services
- Server Notices
- Consent Tracking
- URL Previews
- User Directory
- Message Retention Policies
- Pluggable Modules
  - Third Party Rules
  - Spam Checker
  - Presence Router
  - Media Storage Providers
- Workers
  - Using synctl with Workers
  - Systemd
Administration
- Admin API
- Manhole
- Monitoring
- Request log format
- Scripts

Development

Contributing Guide
Code Style
Git Usage
Testing
OpenTracing
Database Schemas
Synapse Architecture
Internal Documentation
- Single Sign-On
  - SAML
  - CAS
- State Resolution
  - The Auth Chain Difference Algorithm
- Media Repository
- Room and User Statistics
Scripts

Other

Dependency Deprecation Policy