synapse-product/docs
2022-01-05 14:14:16 +00:00
..
admin_api Add admin API to get users' account data (#11664) 2022-01-05 11:49:06 +00:00
development Update backward extremity docs to make it clear that it does not indicate whether we have fetched an events' prev_events (#11469) 2021-12-03 18:25:04 -06:00
modules Make background updates controllable via a plugin (#11306) 2021-11-29 17:57:06 +01:00
other Port wiki pages to documentation website (#11402) 2021-12-01 10:12:19 -08:00
privacy_policy_templates/en Update documentation and templates for new consent 2018-10-12 17:53:14 -06:00
setup Correct Synapse install command for FreeBSD. (#11267) 2022-01-05 10:38:51 +00:00
systemd-with-workers Minor cleanup to Debian packaging (#11269) 2021-11-07 21:18:33 +00:00
usage Document the usage of refresh tokens. (#11427) 2021-12-08 15:31:17 +00:00
website_files Removed page summaries from the top of installation and contributing doc pages (#10711) 2021-08-27 14:19:17 +00:00
.sample_config_header.yaml Fix broken links in INSTALL.md (#10331) 2021-07-08 15:46:13 +01:00
ancient_architecture_notes.md change 'Home Server' to one word 'homeserver' (#11320) 2021-11-16 10:21:01 +00:00
application_services.md Add some explanation to application_services.md (#7091) 2020-04-27 15:03:09 +01:00
architecture.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
auth_chain_diff.dot Use a chain cover index to efficiently calculate auth chain difference (#8868) 2021-01-11 16:09:22 +00:00
auth_chain_diff.dot.png Use a chain cover index to efficiently calculate auth chain difference (#8868) 2021-01-11 16:09:22 +00:00
auth_chain_difference_algorithm.md Use a chain cover index to efficiently calculate auth chain difference (#8868) 2021-01-11 16:09:22 +00:00
CAPTCHA_SETUP.md Improve code formatting and fix a few typos in docs (#11221) 2021-11-01 11:35:55 +00:00
code_style.md Improve code formatting and fix a few typos in docs (#11221) 2021-11-01 11:35:55 +00:00
consent_tracking.md Improve code formatting and fix a few typos in docs (#11221) 2021-11-01 11:35:55 +00:00
delegate.md Support for serving server well-known files (#11211) 2021-11-01 15:10:16 +00:00
deprecation_policy.md Add notes about dropping support for Python 3.6 and Postgres 9.6. 2021-12-21 12:06:31 +00:00
favicon.png Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00
favicon.svg Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00
federate.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
jwt.md Add config for customizing the claim used for JWT logins. (#11361) 2021-11-22 13:01:03 -05:00
log_contexts.md Fix 2 typos in docs/log_contexts.md (#10795) 2021-09-10 16:33:36 +01:00
manhole.md Add config option to use non-default manhole password and keys (#10643) 2021-09-06 16:08:03 +01:00
media_repository.md Update the media repository documentation (#11415) 2021-11-29 15:37:56 +00:00
message_retention_policies.md Improve code formatting and fix a few typos in docs (#11221) 2021-11-01 11:35:55 +00:00
metrics-howto.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
MSC1711_certificates_FAQ.md Update links to MSCs in documentation (#10991) 2021-10-05 11:35:19 +00:00
openid.md Update openid.md 2021-12-01 10:57:55 +00:00
opentracing.md Support enabling opentracing by user (#9978) 2021-05-14 10:51:08 +01:00
password_auth_providers.md Correct target of link to the modules page from the Password Auth Providers page (#11309) 2021-11-12 12:58:39 +00:00
postgres.md Add a note about huge pages to our Postgres doc (#11467) 2021-11-30 19:05:20 -08:00
presence_router_module.md Port the PresenceRouter module interface to the new generic interface (#10524) 2021-08-17 13:22:45 +00:00
README.md Update README.md 2021-11-19 14:01:55 -08:00
replication.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
reverse_proxy.md update ngnix reverse-proxy example (#11680) 2022-01-04 22:31:45 +00:00
room_and_user_statistics.md Remove functionality associated with unused historical stats tables (#9721) 2021-07-08 16:57:13 +01:00
sample_config.yaml Fix link from generated configuration file to documentation (#11678) 2022-01-05 12:16:52 +00:00
sample_log_config.yaml Make PeriodicallyFlushingMemoryHandler the default logging handler. (#10518) 2021-08-17 13:13:11 +01:00
server_notices.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
spam_checker.md Make deprecation notice of the spam checker doc more obvious (#10395) 2021-07-15 15:54:22 +02:00
sso_mapping_providers.md Clarify SSO mapping provider documentation by writing def or async def before the names of methods, as appropriate. (#11681) 2022-01-05 11:25:32 +00:00
structured_logging.md Support generating structured logs in addition to standard logs. (#8607) 2020-10-29 07:27:37 -04:00
SUMMARY.md Document the usage of refresh tokens. (#11427) 2021-12-08 15:31:17 +00:00
synctl_workers.md Improve code formatting and fix a few typos in docs (#11221) 2021-11-01 11:35:55 +00:00
tcp_replication.md Fix deleting pushers when using sharded pushers. (#9465) 2021-02-22 21:14:42 +00:00
templates.md Improved push typing (#11409) 2021-11-30 11:49:20 +00:00
turn-howto.md Add details for how to set up TURN behind NAT (#11553) 2021-12-23 10:42:50 +00:00
upgrade.md Add support removal notice to the upgrade notes 2022-01-05 14:14:16 +00:00
user_directory.md Add an admin API to run background jobs. (#11352) 2021-11-19 19:39:46 +00:00
welcome_and_overview.md Add content to the Synapse documentation intro page (#10990) 2021-10-06 17:09:35 +00:00
workers.md Support the stable /hierarchy endpoint from MSC2946 (#11329) 2021-11-29 14:32:20 -05:00

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.