David Robertson e2a1adbf5d Allow selecting "prejoin" events by state keys (#14642) 2 éve
..
admin_api a3623af74e Add an Admin API endpoint for looking up users based on 3PID (#14405) 2 éve
changelogs e31d06f6f0 Split changelogs by year 2 éve
development 69814eb282 Allow override for requesting specific worker types for Complement on command line. (#14324) 2 éve
modules afbdbe0634 Fix return value in example on `password_auth_provider_callbacks.md` (#13450) 2 éve
other b4461e7d8a Enable complexity checking in complexity checking docs example (#11998) 2 éve
privacy_policy_templates 22a2004428 Update documentation and templates for new consent 6 éve
setup 7aefc7e9fc Cite launchpad bug that says ubuntu's pkgs are old (#14517) 2 éve
systemd-with-workers 0adeccafc6 Add sample worker files for `pusher` and `federation_sender` (#14077) 2 éve
usage e2a1adbf5d Allow selecting "prejoin" events by state keys (#14642) 2 éve
website_files 0922462fc7 docs: Don't render the table of contents on the print page (#12340) 2 éve
.sample_config_header.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) 2 éve
CAPTCHA_SETUP.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 éve
README.md d9e9771d6b Update README.md 3 éve
SUMMARY.md 64dd8a9c6e Include additional TURN server example into documentation (#14293) 2 éve
ancient_architecture_notes.md e72135b9d3 change 'Home Server' to one word 'homeserver' (#11320) 3 éve
application_services.md aa2492907f Add some explanation to application_services.md (#7091) 4 éve
architecture.md 379d2a8c39 (#5849) Convert rst to markdown (#6040) 5 éve
auth_chain_diff.dot 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 éve
auth_chain_diff.dot.png 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 éve
auth_chain_difference_algorithm.md a25a37002c Write about the chain cover a little. (#13602) 2 éve
code_style.md 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 2 éve
consent_tracking.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 éve
delegate.md 71f9966f27 Support for serving server well-known files (#11211) 3 éve
deprecation_policy.md 77f3986451 Define SQLite compat policy (#13728) 2 éve
favicon.png fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 éve
favicon.svg fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 éve
federate.md 9a0172d49f Clean-up demo scripts & documentation (#12143) 2 éve
jwt.md 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 2 éve
log_contexts.md ceab5a4bfa Fix 2 typos in docs/log_contexts.md (#10795) 3 éve
manhole.md 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 2 éve
media_repository.md 1381563988 Inline URL preview documentation. (#13261) 2 éve
message_retention_policies.md 73c83c6411 Add a warning to retention documentation regarding the possibility of database corruption (#13497) 2 éve
metrics-howto.md 78909f5028 Include monthly active user metrics in the list of legacy metrics names (#14360) 2 éve
openid.md d69bf3b24c Add Mastodon SSO setup instructions to docs (#14594) 2 éve
opentracing.md 3d94d07db3 Update opentracing docs to reference the configuration manual rather than the configuation file. (#13076) 2 éve
password_auth_providers.md 4ad5ee9996 Correct target of link to the modules page from the Password Auth Providers page (#11309) 3 éve
postgres.md 66d47b44cd docs: Replace old note about Postgres 10+ being required with link to our deprecation policy (#14590) 2 éve
presence_router_module.md 1a9f531c79 Port the PresenceRouter module interface to the new generic interface (#10524) 3 éve
replication.md d80a7ab151 Update `replication.md` with info on TCP module structure (#12621) 2 éve
reverse_proxy.md 334a8324d3 Update sample Nginx configuration to HTTP 1.1 (#14414) 2 éve
room_and_user_statistics.md f6767abc05 Remove functionality associated with unused historical stats tables (#9721) 3 éve
sample_config.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) 2 éve
sample_log_config.yaml 1357ae869f Add workers settings to configuration manual (#14086) 2 éve
server_notices.md c141455049 Docs: Use something other than the document name to describe a page (#10399) 3 éve
spam_checker.md 3fffb71254 Make deprecation notice of the spam checker doc more obvious (#10395) 3 éve
sso_mapping_providers.md 16e1a9d9a7 Correct documentation for map_user_attributes of OpenID Mapping Providers (#13836) 2 éve
structured_logging.md 298911555c Fix typos in documentation (#12863) 2 éve
synctl_workers.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 éve
tcp_replication.md 66f4949e7f Fix deleting pushers when using sharded pushers. (#9465) 3 éve
templates.md b71b41c7bd Fix a typo in docs and in some warnings (#13538) 2 éve
turn-howto.md 9a9568168a Change `turn_allow_guests` example value to lowercase `true` (#14634) 2 éve
upgrade.md 9af2be192a Remove legacy Prometheus metrics names. They were deprecated in Synapse v1.69.0 and disabled by default in Synapse v1.71.0. (#14538) 2 éve
user_directory.md ea20937084 Add an admin API to run background jobs. (#11352) 3 éve
welcome_and_overview.md a167304c8b Switch the 'Configuration' link in the docs homepage to the config manual (#12748) 2 éve
workers.md 6acb6d772a Update worker docs to update preferred settings for pusher and federation_sender (#14493) 2 éve

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.