Action Bot 1656889dd6 Version picker added for v1.62 docs 1 year ago
..
admin_api 3ceaf1462d Remove docs for Delete Group Admin API (#13112) 2 years ago
changelogs e31d06f6f0 Split changelogs by year 2 years ago
development ffe2464836 Add instructions for running Complement with `gotestfmt`-formatted output locally. (#13073) 2 years ago
modules bdb6628dcf Fix version number in spam checker callbacks doc (#13047) 2 years ago
other b4461e7d8a Enable complexity checking in complexity checking docs example (#11998) 2 years ago
privacy_policy_templates 22a2004428 Update documentation and templates for new consent 6 years ago
setup 5d6f55959e Update info on downstream debs (#13095) 2 years ago
systemd-with-workers a36a38b1ca Add some example configurations for worker (#12492) 2 years ago
usage 0ef1307619 Add custom well-known (#13035) 2 years ago
website_files 1656889dd6 Version picker added for v1.62 docs 1 year ago
.sample_config_header.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) 2 years ago
CAPTCHA_SETUP.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 years ago
README.md d9e9771d6b Update README.md 3 years ago
SUMMARY.md 3ceaf1462d Remove docs for Delete Group Admin API (#13112) 2 years ago
ancient_architecture_notes.md e72135b9d3 change 'Home Server' to one word 'homeserver' (#11320) 3 years ago
application_services.md aa2492907f Add some explanation to application_services.md (#7091) 4 years ago
architecture.md 379d2a8c39 (#5849) Convert rst to markdown (#6040) 5 years ago
auth_chain_diff.dot 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 years ago
auth_chain_diff.dot.png 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 years ago
auth_chain_difference_algorithm.md 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 years ago
code_style.md 535a689cfc Reintroduce the lint targets in the linter script (#12455) 2 years ago
consent_tracking.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 years ago
delegate.md 71f9966f27 Support for serving server well-known files (#11211) 3 years ago
deprecation_policy.md 57ca8ab10f Add notes about dropping support for Python 3.6 and Postgres 9.6. 3 years ago
favicon.png fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 years ago
favicon.svg fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 years ago
federate.md 9a0172d49f Clean-up demo scripts & documentation (#12143) 2 years ago
jwt.md 7d99414edf Replace pyjwt with authlib in `org.matrix.login.jwt` (#13011) 2 years ago
log_contexts.md ceab5a4bfa Fix 2 typos in docs/log_contexts.md (#10795) 3 years ago
manhole.md e24ff8ebe3 Remove `HomeServer.get_datastore()` (#12031) 2 years ago
media_repository.md 7564b8e118 Update the media repository documentation (#11415) 3 years ago
message_retention_policies.md 298911555c Fix typos in documentation (#12863) 2 years ago
metrics-howto.md 0adc2882c1 Fix broken links in documentation (#10180) 3 years ago
openid.md 5675cebfaa openid.md: fix some links 2 years ago
opentracing.md 3d94d07db3 Update opentracing docs to reference the configuration manual rather than the configuation file. (#13076) 2 years ago
password_auth_providers.md 4ad5ee9996 Correct target of link to the modules page from the Password Auth Providers page (#11309) 3 years ago
postgres.md e78d4f61fc Refuse to start if DB has an unsafe locale (#12262) 2 years ago
presence_router_module.md 1a9f531c79 Port the PresenceRouter module interface to the new generic interface (#10524) 3 years ago
replication.md d80a7ab151 Update `replication.md` with info on TCP module structure (#12621) 2 years ago
reverse_proxy.md d9b71410c2 Add HAProxy delegation example to docs (#12501) 2 years ago
room_and_user_statistics.md f6767abc05 Remove functionality associated with unused historical stats tables (#9721) 3 years ago
sample_config.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) 2 years ago
sample_log_config.yaml 8d156ec0ba Remove special-case for `twisted` logger (#12589) 2 years ago
server_notices.md c141455049 Docs: Use something other than the document name to describe a page (#10399) 3 years ago
spam_checker.md 3fffb71254 Make deprecation notice of the spam checker doc more obvious (#10395) 3 years ago
sso_mapping_providers.md 84d790a32e Clarify SSO mapping provider documentation by writing `def` or `async def` before the names of methods, as appropriate. (#11681) 2 years ago
structured_logging.md 298911555c Fix typos in documentation (#12863) 2 years ago
synctl_workers.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 years ago
tcp_replication.md 66f4949e7f Fix deleting pushers when using sharded pushers. (#9465) 3 years ago
templates.md e6a106fd5e Implement a Jinja2 filter to extract localparts from email addresses (#12212) 2 years ago
turn-howto.md f46b223354 turn-howto: fix some links 2 years ago
upgrade.md 5d139f578d Merge branch 'release-v1.61' into develop 2 years ago
user_directory.md ea20937084 Add an admin API to run background jobs. (#11352) 3 years ago
welcome_and_overview.md a167304c8b Switch the 'Configuration' link in the docs homepage to the config manual (#12748) 2 years ago
workers.md 7bc08f3201 Remove remaining bits of groups code. (#12936) 2 years 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.