You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Brendan Abolivier c7a5e49664
Implement an `on_new_event` callback (#11126)
1 day ago
..
admin_api Enable changing user type via users admin API (#11174) 2 days ago
development Include the requirements for [mypy,lint] in [dev] (#11034) 2 weeks ago
modules Implement an `on_new_event` callback (#11126) 1 day ago
privacy_policy_templates/en Update documentation and templates for new consent 3 years ago
setup Update installation instructions (#10919) 4 weeks ago
systemd-with-workers Docs: Use something other than the document name to describe a page (#10399) 3 months ago
usage Remove false warning about copying the log config to a homeserver.yaml (#11092) 1 week ago
website_files Removed page summaries from the top of installation and contributing doc pages (#10711) 2 months ago
.sample_config_header.yaml Fix broken links in INSTALL.md (#10331) 4 months ago
CAPTCHA_SETUP.md Update CAPTCHA documentation to mention turning off verify origin feature (#10046) 5 months ago
MSC1711_certificates_FAQ.md Update links to MSCs in documentation (#10991) 3 weeks ago
README.md Remove "reference" wording according Synapse homeserver (#10971) 3 weeks ago
SUMMARY.md Port the Password Auth Providers module interface to the new generic interface (#10548) 2 weeks ago
ancient_architecture_notes.md (#5849) Convert rst to markdown (#6040) 2 years ago
application_services.md Add some explanation to application_services.md (#7091) 2 years ago
architecture.md (#5849) Convert rst to markdown (#6040) 2 years ago
auth_chain_diff.dot Use a chain cover index to efficiently calculate auth chain difference (#8868) 10 months ago
auth_chain_diff.dot.png Use a chain cover index to efficiently calculate auth chain difference (#8868) 10 months ago
auth_chain_difference_algorithm.md Use a chain cover index to efficiently calculate auth chain difference (#8868) 10 months ago
code_style.md Replace `room_invite_state_types` with `room_prejoin_state` (#9700) 7 months ago
consent_tracking.md Docs: Use something other than the document name to describe a page (#10399) 3 months ago
delegate.md Docs: Use something other than the document name to describe a page (#10399) 3 months ago
deprecation_policy.md Add deprecation policy doc (#9723) 7 months ago
favicon.png Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 5 months ago
favicon.svg Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 5 months ago
federate.md Docs: Use something other than the document name to describe a page (#10399) 3 months ago
jwt.md Return the proper 403 Forbidden error during errors with JWT logins. (#7844) 1 year ago
log_contexts.md Fix 2 typos in docs/log_contexts.md (#10795) 2 months ago
manhole.md Add config option to use non-default manhole password and keys (#10643) 2 months ago
media_repository.md Fix documentation of directory name for remote thumbnails (#10556) 2 months ago
message_retention_policies.md Fix broken links in documentation (#10180) 4 months ago
metrics-howto.md Fix broken links in documentation (#10180) 4 months ago
openid.md doc: add django-oauth-toolkit to oidc doc (#10192) 2 months ago
opentracing.md Support enabling opentracing by user (#9978) 6 months ago
password_auth_providers.md Port the Password Auth Providers module interface to the new generic interface (#10548) 2 weeks ago
postgres.md Fix broken links in INSTALL.md (#10331) 4 months ago
presence_router_module.md Port the PresenceRouter module interface to the new generic interface (#10524) 2 months ago
replication.md Docs: Use something other than the document name to describe a page (#10399) 3 months ago
reverse_proxy.md Clarifications to reverse_proxy.md (#10708) 2 months ago
room_and_user_statistics.md Remove functionality associated with unused historical stats tables (#9721) 4 months ago
sample_config.yaml Move experimental & retention config out of the server module. (#11070) 2 weeks ago
sample_log_config.yaml Make `PeriodicallyFlushingMemoryHandler` the default logging handler. (#10518) 2 months ago
server_notices.md Docs: Use something other than the document name to describe a page (#10399) 3 months ago
spam_checker.md Make deprecation notice of the spam checker doc more obvious (#10395) 3 months ago
sso_mapping_providers.md Fix broken links in documentation (#10180) 4 months ago
structured_logging.md Support generating structured logs in addition to standard logs. (#8607) 1 year ago
synctl_workers.md Update worker docs with recent enhancements (#7969) 1 year ago
tcp_replication.md Fix deleting pushers when using sharded pushers. (#9465) 8 months ago
templates.md Centralise the custom template directory (#10596) 2 months ago
turn-howto.md Make link in docs use HTTPS (#10130) 5 months ago
upgrade.md Fix instances of [example]{.title-ref} in the upgrade notes (#11118) 1 week ago
user_directory.md Easy refactors of the user directory (#10789) 2 months ago
welcome_and_overview.md Add content to the Synapse documentation intro page (#10990) 3 weeks ago
workers.md Document that /spaces & /hierarchy can be routed to workers. (#10648) 2 months 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. You can browse the book by opening book/index.html in a web browser.

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.