H. Shay eafdb12dd8 update changelog and upgrade notes 2 days ago
..
admin_api 4eb2f4e02b Fix broken links in the Synapse documentation. (#14744) 4 weeks ago
changelogs e31d06f6f0 Split changelogs by year 9 months ago
development cbb0ee43cc Initial batch of notes on faster joins (#14677) 3 days ago
modules 4eb2f4e02b Fix broken links in the Synapse documentation. (#14744) 4 weeks ago
other b4461e7d8a Enable complexity checking in complexity checking docs example (#11998) 11 months ago
privacy_policy_templates 22a2004428 Update documentation and templates for new consent 4 years ago
setup 4eb2f4e02b Fix broken links in the Synapse documentation. (#14744) 4 weeks ago
systemd-with-workers d344bc8b6e Include `x_forwarded` in workers example configs (#14667) 2 weeks ago
usage b15f0758e5 Document the export user data command. (#14883) 1 week ago
website_files 0922462fc7 docs: Don't render the table of contents on the print page (#12340) 9 months ago
.sample_config_header.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) 7 months ago
CAPTCHA_SETUP.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 1 year ago
README.md d9e9771d6b Update README.md 1 year ago
SUMMARY.md cbb0ee43cc Initial batch of notes on faster joins (#14677) 3 days ago
ancient_architecture_notes.md e72135b9d3 change 'Home Server' to one word 'homeserver' (#11320) 1 year ago
application_services.md 7801fd74da Fix missing field in AS documentation (#14845) 2 weeks ago
architecture.md 379d2a8c39 (#5849) Convert rst to markdown (#6040) 3 years ago
auth_chain_diff.dot 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 2 years ago
auth_chain_diff.dot.png 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 2 years ago
auth_chain_difference_algorithm.md a25a37002c Write about the chain cover a little. (#13602) 5 months ago
code_style.md f4d2a734f9 Remove outdated commands from the code style doc & point to the contributing guide. (#14773) 3 weeks ago
consent_tracking.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 1 year ago
delegate.md 71f9966f27 Support for serving server well-known files (#11211) 1 year ago
deprecation_policy.md 77f3986451 Define SQLite compat policy (#13728) 4 months ago
favicon.png fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 1 year ago
favicon.svg fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 1 year ago
federate.md 9a0172d49f Clean-up demo scripts & documentation (#12143) 11 months ago
jwt.md 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 7 months ago
log_contexts.md ceab5a4bfa Fix 2 typos in docs/log_contexts.md (#10795) 1 year ago
manhole.md 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 7 months ago
media_repository.md 1381563988 Inline URL preview documentation. (#13261) 6 months ago
message_retention_policies.md 73c83c6411 Add a warning to retention documentation regarding the possibility of database corruption (#13497) 5 months ago
metrics-howto.md 78909f5028 Include monthly active user metrics in the list of legacy metrics names (#14360) 3 months ago
openid.md 4eb2f4e02b Fix broken links in the Synapse documentation. (#14744) 4 weeks ago
opentracing.md 3d94d07db3 Update opentracing docs to reference the configuration manual rather than the configuation file. (#13076) 7 months ago
password_auth_providers.md 4ad5ee9996 Correct target of link to the modules page from the Password Auth Providers page (#11309) 1 year ago
postgres.md 4eb2f4e02b Fix broken links in the Synapse documentation. (#14744) 4 weeks ago
presence_router_module.md 1a9f531c79 Port the PresenceRouter module interface to the new generic interface (#10524) 1 year ago
replication.md d80a7ab151 Update `replication.md` with info on TCP module structure (#12621) 8 months ago
reverse_proxy.md 8d20b1ba1e Broken link "request_id_header" (#14740) 1 month ago
room_and_user_statistics.md f6767abc05 Remove functionality associated with unused historical stats tables (#9721) 1 year ago
sample_config.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) 7 months ago
sample_log_config.yaml 1357ae869f Add workers settings to configuration manual (#14086) 3 months ago
server_notices.md c141455049 Docs: Use something other than the document name to describe a page (#10399) 1 year ago
spam_checker.md 3fffb71254 Make deprecation notice of the spam checker doc more obvious (#10395) 1 year ago
sso_mapping_providers.md 4eb2f4e02b Fix broken links in the Synapse documentation. (#14744) 4 weeks ago
structured_logging.md 298911555c Fix typos in documentation (#12863) 8 months ago
synctl_workers.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 1 year ago
tcp_replication.md 66f4949e7f Fix deleting pushers when using sharded pushers. (#9465) 1 year ago
templates.md b71b41c7bd Fix a typo in docs and in some warnings (#13538) 5 months ago
turn-howto.md 9a9568168a Change `turn_allow_guests` example value to lowercase `true` (#14634) 1 month ago
upgrade.md eafdb12dd8 update changelog and upgrade notes 2 days ago
user_directory.md ea20937084 Add an admin API to run background jobs. (#11352) 1 year ago
welcome_and_overview.md a167304c8b Switch the 'Configuration' link in the docs homepage to the config manual (#12748) 8 months ago
workers.md 3479599387 Add missing worker settings to shared configuration (#14748) 3 weeks ago

README.md

Synapse Documentation

The documentation is currently hosted here. Please update any links to point to the new website instead.

About

This directory currently holds a series of markdown files documenting how to install, use and develop Synapse. The documentation is readable directly from this repository, but it is recommended to instead browse through the website for easier discoverability.

Adding to the documentation

Most of the documentation currently exists as top-level files, as when organising them into a structured website, these files were kept in place so that existing links would not break. The rest of the documentation is stored in folders, such as setup, usage, and development etc. All new documentation files should be placed in structured folders. For example:

To create a new user-facing documentation page about a new Single Sign-On protocol named "MyCoolProtocol", one should create a new file with a relevant name, such as "my_cool_protocol.md". This file might fit into the documentation structure at:

  • Usage
    • Configuration
    • User Authentication
      • Single Sign-On
      • My Cool Protocol

Given that, one would place the new file under usage/configuration/user_authentication/single_sign_on/my_cool_protocol.md.

Note that the structure of the documentation (and thus the left sidebar on the website) is determined by the list in SUMMARY.md. The final thing to do when adding a new page is to add a new line linking to the new documentation file:

- [My Cool Protocol](usage/configuration/user_authentication/single_sign_on/my_cool_protocol.md)

Building the documentation

The documentation is built with mdbook, and the outline of the documentation is determined by the structure of SUMMARY.md.

First, get mdbook. Then, from the root of the repository, build the documentation with:

mdbook build

The rendered contents will be outputted to a new book/ directory at the root of the repository. Please note that index.html is not built by default, it is created by copying over the file welcome_and_overview.html to index.html during deployment. Thus, when running mdbook serve locally the book will initially show a 404 in place of the index due to the above. Do not be alarmed!

You can also have mdbook host the docs on a local webserver with hot-reload functionality via:

mdbook serve

The URL at which the docs can be viewed at will be logged.

Configuration and theming

The look and behaviour of the website is configured by the book.toml file at the root of the repository. See mdbook's documentation on configuration for available options.

The site can be themed and additionally extended with extra UI and features. See website_files/README.md for details.