Dirk Klimpel 0da2301b21 Consolidate the `access_token` information in the admin api (#11861) 2 år sedan
..
admin_api 0da2301b21 Consolidate the `access_token` information in the admin api (#11861) 2 år sedan
development fc8598bc87 Minor updates, and docs, for schema delta files (#11823) 2 år sedan
modules 2d3bd9aa67 Add a module callback to set username at registration (#11790) 2 år sedan
other 84dc50e160 Port wiki pages to documentation website (#11402) 3 år sedan
privacy_policy_templates 22a2004428 Update documentation and templates for new consent 6 år sedan
setup ec07062e31 Update installation docs to indicate that we support Python 3.10 (#11820) 2 år sedan
systemd-with-workers 9799c569bb Minor cleanup to Debian packaging (#11269) 3 år sedan
usage 6a72c910f1 Add admin API to get a list of federated rooms (#11658) 2 år sedan
website_files 54aa7047eb Removed page summaries from the top of installation and contributing doc pages (#10711) 3 år sedan
.sample_config_header.yaml 974261cd81 Fix broken links in INSTALL.md (#10331) 3 år sedan
CAPTCHA_SETUP.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 år sedan
MSC1711_certificates_FAQ.md 7eb198ddc8 Remove not needed old table of contents in documentation (#11860) 2 år sedan
README.md d9e9771d6b Update README.md 3 år sedan
SUMMARY.md 83a74d9350 Document the usage of refresh tokens. (#11427) 3 år sedan
ancient_architecture_notes.md e72135b9d3 change 'Home Server' to one word 'homeserver' (#11320) 3 år sedan
application_services.md aa2492907f Add some explanation to application_services.md (#7091) 4 år sedan
architecture.md 379d2a8c39 (#5849) Convert rst to markdown (#6040) 5 år sedan
auth_chain_diff.dot 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 år sedan
auth_chain_diff.dot.png 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 år sedan
auth_chain_difference_algorithm.md 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 år sedan
code_style.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 år sedan
consent_tracking.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 år sedan
delegate.md 71f9966f27 Support for serving server well-known files (#11211) 3 år sedan
deprecation_policy.md 57ca8ab10f Add notes about dropping support for Python 3.6 and Postgres 9.6. 3 år sedan
favicon.png fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 år sedan
favicon.svg fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 år sedan
federate.md c141455049 Docs: Use something other than the document name to describe a page (#10399) 3 år sedan
jwt.md 1035663833 Add config for customizing the claim used for JWT logins. (#11361) 3 år sedan
log_contexts.md ceab5a4bfa Fix 2 typos in docs/log_contexts.md (#10795) 3 år sedan
manhole.md 6e895366ea Add config option to use non-default manhole password and keys (#10643) 3 år sedan
media_repository.md 7564b8e118 Update the media repository documentation (#11415) 3 år sedan
message_retention_policies.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 år sedan
metrics-howto.md 0adc2882c1 Fix broken links in documentation (#10180) 3 år sedan
openid.md b0352f9c08 Update documentation for configuring facebook login (#11755) 2 år sedan
opentracing.md c14f99be46 Support enabling opentracing by user (#9978) 3 år sedan
password_auth_providers.md 4ad5ee9996 Correct target of link to the modules page from the Password Auth Providers page (#11309) 3 år sedan
postgres.md 2185b28184 Fix documentation of supported PostgreSQL version (#11725) 2 år sedan
presence_router_module.md 1a9f531c79 Port the PresenceRouter module interface to the new generic interface (#10524) 3 år sedan
replication.md c141455049 Docs: Use something other than the document name to describe a page (#10399) 3 år sedan
reverse_proxy.md 79f6d3550a update ngnix reverse-proxy example (#11680) 2 år sedan
room_and_user_statistics.md f6767abc05 Remove functionality associated with unused historical stats tables (#9721) 3 år sedan
sample_config.yaml bf60da1a60 Configurable limits on avatars (#11846) 2 år sedan
sample_log_config.yaml 5f7b1e1f27 Make `PeriodicallyFlushingMemoryHandler` the default logging handler. (#10518) 3 år sedan
server_notices.md c141455049 Docs: Use something other than the document name to describe a page (#10399) 3 år sedan
spam_checker.md 3fffb71254 Make deprecation notice of the spam checker doc more obvious (#10395) 3 år sedan
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 år sedan
structured_logging.md 00b24aa545 Support generating structured logs in addition to standard logs. (#8607) 4 år sedan
synctl_workers.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 år sedan
tcp_replication.md 66f4949e7f Fix deleting pushers when using sharded pushers. (#9465) 3 år sedan
templates.md a9481223d1 Improved push typing (#11409) 3 år sedan
turn-howto.md cefd4b87a3 Warn against using Let's Encrypt certs for encrypted TURN (#11686) 2 år sedan
upgrade.md 91221b6961 Add deprecation warnings for `webclient` listener and non-HTTP(S) `web_client_location`. (#11774) 2 år sedan
user_directory.md ea20937084 Add an admin API to run background jobs. (#11352) 3 år sedan
welcome_and_overview.md e564bdd127 Add content to the Synapse documentation intro page (#10990) 3 år sedan
workers.md a4521ce0a8 Support the stable /hierarchy endpoint from MSC2946 (#11329) 3 år sedan

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.