reivilibre 67f51c84f8 Merge the Complement testing Docker images into a single, multi-purpose image. (#12881)		2 tahun lalu
..
admin_api	fcd8703508 Allow updating passwords using the admin api without logging out devices (#12952)	2 tahun lalu
changelogs	e31d06f6f0 Split changelogs by year	2 tahun lalu
development	67f51c84f8 Merge the Complement testing Docker images into a single, multi-purpose image. (#12881)	2 tahun lalu
modules	8fd87739bf Fix import in module_api module and docs on the new check_event_for_spam signature (#12918)	2 tahun lalu
other	b4461e7d8a Enable complexity checking in complexity checking docs example (#11998)	2 tahun lalu
privacy_policy_templates	22a2004428 Update documentation and templates for new consent	5 tahun lalu
setup	ec07062e31 Update installation docs to indicate that we support Python 3.10 (#11820)	2 tahun lalu
systemd-with-workers	a36a38b1ca Add some example configurations for worker (#12492)	2 tahun lalu
usage	a47636c570 Prevent local quarantined media from being claimed by media retention (#12972)	2 tahun lalu
website_files	0922462fc7 docs: Don't render the table of contents on the print page (#12340)	2 tahun lalu
.sample_config_header.yaml	974261cd81 Fix broken links in INSTALL.md (#10331)	3 tahun lalu
CAPTCHA_SETUP.md	ece84f2c45 Improve code formatting and fix a few typos in docs (#11221)	2 tahun lalu
README.md	d9e9771d6b Update README.md	2 tahun lalu
SUMMARY.md	3d8839c30c Add documentation for cancellation of request processing (#12761)	2 tahun lalu
ancient_architecture_notes.md	e72135b9d3 change 'Home Server' to one word 'homeserver' (#11320)	2 tahun lalu
application_services.md	aa2492907f Add some explanation to application_services.md (#7091)	4 tahun lalu
architecture.md	379d2a8c39 (#5849) Convert rst to markdown (#6040)	4 tahun lalu
auth_chain_diff.dot	1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868)	3 tahun lalu
auth_chain_diff.dot.png	1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868)	3 tahun lalu
auth_chain_difference_algorithm.md	1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868)	3 tahun lalu
code_style.md	535a689cfc Reintroduce the lint targets in the linter script (#12455)	2 tahun lalu
consent_tracking.md	ece84f2c45 Improve code formatting and fix a few typos in docs (#11221)	2 tahun lalu
delegate.md	71f9966f27 Support for serving server well-known files (#11211)	2 tahun lalu
deprecation_policy.md	57ca8ab10f Add notes about dropping support for Python 3.6 and Postgres 9.6.	2 tahun lalu
favicon.png	fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)	3 tahun lalu
favicon.svg	fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)	3 tahun lalu
federate.md	9a0172d49f Clean-up demo scripts & documentation (#12143)	2 tahun lalu
jwt.md	ba3fd54bad Remove unstable/unspecced login types. (#12597)	2 tahun lalu
log_contexts.md	ceab5a4bfa Fix 2 typos in docs/log_contexts.md (#10795)	2 tahun lalu
manhole.md	e24ff8ebe3 Remove `HomeServer.get_datastore()` (#12031)	2 tahun lalu
media_repository.md	7564b8e118 Update the media repository documentation (#11415)	2 tahun lalu
message_retention_policies.md	298911555c Fix typos in documentation (#12863)	2 tahun lalu
metrics-howto.md	0adc2882c1 Fix broken links in documentation (#10180)	3 tahun lalu
openid.md	5675cebfaa openid.md: fix some links	2 tahun lalu
opentracing.md	c14f99be46 Support enabling opentracing by user (#9978)	3 tahun lalu
password_auth_providers.md	4ad5ee9996 Correct target of link to the modules page from the Password Auth Providers page (#11309)	2 tahun lalu
postgres.md	e78d4f61fc Refuse to start if DB has an unsafe locale (#12262)	2 tahun lalu
presence_router_module.md	1a9f531c79 Port the PresenceRouter module interface to the new generic interface (#10524)	2 tahun lalu
replication.md	d80a7ab151 Update `replication.md` with info on TCP module structure (#12621)	2 tahun lalu
reverse_proxy.md	d9b71410c2 Add HAProxy delegation example to docs (#12501)	2 tahun lalu
room_and_user_statistics.md	f6767abc05 Remove functionality associated with unused historical stats tables (#9721)	3 tahun lalu
sample_config.yaml	053ca5f3ca Merge tag 'v1.60.0rc2' into develop	2 tahun lalu
sample_log_config.yaml	8d156ec0ba Remove special-case for `twisted` logger (#12589)	2 tahun lalu
server_notices.md	c141455049 Docs: Use something other than the document name to describe a page (#10399)	2 tahun lalu
spam_checker.md	3fffb71254 Make deprecation notice of the spam checker doc more obvious (#10395)	2 tahun lalu
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 tahun lalu
structured_logging.md	298911555c Fix typos in documentation (#12863)	2 tahun lalu
synctl_workers.md	ece84f2c45 Improve code formatting and fix a few typos in docs (#11221)	2 tahun lalu
tcp_replication.md	66f4949e7f Fix deleting pushers when using sharded pushers. (#9465)	3 tahun lalu
templates.md	e6a106fd5e Implement a Jinja2 filter to extract localparts from email addresses (#12212)	2 tahun lalu
turn-howto.md	f46b223354 turn-howto: fix some links	2 tahun lalu
upgrade.md	8fd87739bf Fix import in module_api module and docs on the new check_event_for_spam signature (#12918)	2 tahun lalu
user_directory.md	ea20937084 Add an admin API to run background jobs. (#11352)	2 tahun lalu
welcome_and_overview.md	a167304c8b Switch the 'Configuration' link in the docs homepage to the config manual (#12748)	2 tahun lalu
workers.md	7bc08f3201 Remove remaining bits of groups code. (#12936)	2 tahun lalu

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.