synapse/docs
2022-05-16 17:31:12 +00:00
..
admin_api Fix reference to the wrong symbol in the media admin api docs (#12715) 2022-05-12 09:29:37 +01:00
changelogs Split changelogs by year 2022-04-12 13:54:36 +01:00
development Fix docs on how to run specific Complement tests after recent complement.sh change (#12664) 2022-05-09 10:38:32 +01:00
modules Add a module callback to react to account data changes (#12327) 2022-04-01 11:22:48 +02:00
other Enable complexity checking in complexity checking docs example (#11998) 2022-03-02 16:11:16 +00:00
privacy_policy_templates/en
setup Update installation docs to indicate that we support Python 3.10 (#11820) 2022-01-26 16:05:29 -08:00
systemd-with-workers Add some example configurations for worker (#12492) 2022-04-25 13:17:03 +01:00
usage Fix typo in name of 'run_background_tasks_on' option in config manual (#12749) 2022-05-16 17:31:12 +00:00
website_files docs: Don't render the table of contents on the print page (#12340) 2022-04-13 08:27:51 -07:00
.sample_config_header.yaml
ancient_architecture_notes.md change 'Home Server' to one word 'homeserver' (#11320) 2021-11-16 10:21:01 +00:00
application_services.md
architecture.md
auth_chain_diff.dot
auth_chain_diff.dot.png
auth_chain_difference_algorithm.md
CAPTCHA_SETUP.md
code_style.md Reintroduce the lint targets in the linter script (#12455) 2022-04-14 11:33:06 +01:00
consent_tracking.md
delegate.md
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
favicon.svg
federate.md Clean-up demo scripts & documentation (#12143) 2022-03-08 15:02:59 -05:00
jwt.md Remove unstable/unspecced login types. (#12597) 2022-05-04 13:53:21 +00:00
log_contexts.md
manhole.md Remove HomeServer.get_datastore() (#12031) 2022-02-23 11:04:02 +00:00
media_repository.md Update the media repository documentation (#11415) 2021-11-29 15:37:56 +00:00
message_retention_policies.md
metrics-howto.md
openid.md Update issuer URL in example OIDC Keycloak config (#12727) 2022-05-13 10:15:51 +00:00
opentracing.md
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 Refuse to start if DB has an unsafe locale (#12262) 2022-03-23 10:23:05 -07:00
presence_router_module.md
README.md Update README.md 2021-11-19 14:01:55 -08:00
replication.md Update replication.md with info on TCP module structure (#12621) 2022-05-09 14:46:43 -07:00
reverse_proxy.md Add HAProxy delegation example to docs (#12501) 2022-04-25 13:18:18 +01:00
room_and_user_statistics.md
sample_config.yaml Fix typo in listener config (#12742) 2022-05-16 13:50:07 +00:00
sample_log_config.yaml Remove special-case for twisted logger (#12589) 2022-04-29 22:05:18 +01:00
server_notices.md
spam_checker.md
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 Remove docs for converting a legacy structured logging config. (#12392) 2022-04-06 13:41:14 -04:00
SUMMARY.md Add a manual documenting config file options (#12368) 2022-04-18 11:32:30 -07:00
synctl_workers.md
tcp_replication.md
templates.md Implement a Jinja2 filter to extract localparts from email addresses (#12212) 2022-03-11 15:15:11 +00:00
turn-howto.md turn-howto: fix some links 2022-04-22 14:23:40 +01:00
upgrade.md Add the update_user_directory_from_worker configuration option (superseding update_user_directory) to allow a generic worker to be designated as the worker to update the user directory. (#12654) 2022-05-10 11:08:45 +01: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
workers.md Add the update_user_directory_from_worker configuration option (superseding update_user_directory) to allow a generic worker to be designated as the worker to update the user directory. (#12654) 2022-05-10 11:08:45 +01: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.