MatrixSynapse/docs
Erik Johnston e85e0ef6ba Merge remote-tracking branch 'origin/master' into develop 2023-12-12 17:37:17 +00:00
..
admin_api Update admin user API return types in docs. (#16654) 2023-11-17 13:38:25 +00:00
changelogs Add links to pre-1.0 changelog issue/PR references. (#16638) 2023-11-15 13:31:24 +00:00
development Fix poetry version typo in contributors' guide (#16695) 2023-11-27 15:16:20 +00:00
modules ModuleAPI SSO auth callbacks (#15207) 2023-12-01 14:31:50 +00:00
other Enable complexity checking in complexity checking docs example (#11998) 2022-03-02 16:11:16 +00:00
privacy_policy_templates/en Update documentation and templates for new consent 2018-10-12 17:53:14 -06:00
setup docs: Link to the Alpine Linux community package for Synapse (#16304) 2023-09-14 14:13:48 +01:00
systemd-with-workers Remove `worker_replication_*` settings from worker doc (#15872) 2023-07-07 08:09:41 +00:00
usage Sentry Alert configuration based on production and development environment (#16738) 2023-12-12 16:04:41 +00:00
website_files Merge remote-tracking branch 'origin/master' into develop 2023-12-12 17:37:17 +00:00
.sample_config_header.yaml Remove code generating comments in configuration file (#12941) 2022-06-14 07:53:42 -07:00
CAPTCHA_SETUP.md Improve code formatting and fix a few typos in docs (#11221) 2021-11-01 11:35:55 +00:00
README.md Update README.md 2021-11-19 14:01:55 -08:00
SUMMARY.md Add new module API for adding custom fields to events `unsigned` section (#16549) 2023-10-27 09:04:08 +00:00
ancient_architecture_notes.md Fix-up incorrect spellings in docs. (#16282) 2023-09-08 09:47:36 -04:00
application_services.md Fix missing field in AS documentation (#14845) 2023-01-16 12:59:15 +00: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 Write about the chain cover a little. (#13602) 2022-08-23 17:41:55 +00:00
code_style.md Remove outdated commands from the code style doc & point to the contributing guide. (#14773) 2023-01-11 15:21:12 +00:00
consent_tracking.md Fix-up incorrect spellings in docs. (#16282) 2023-09-08 09:47:36 -04:00
delegate.md Clarify limitations of SRV delegation in documentation (#14959) 2023-02-08 10:44:19 +00:00
deprecation_policy.md Drop debian buster (#15893) 2023-07-10 10:39:36 -07: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 Clean-up demo scripts & documentation (#12143) 2022-03-08 15:02:59 -05:00
jwt.md Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 2022-06-30 09:21:39 -07:00
log_contexts.md Fix-up incorrect spellings in docs. (#16282) 2023-09-08 09:47:36 -04:00
manhole.md Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 2022-06-30 09:21:39 -07:00
media_repository.md Inline URL preview documentation. (#13261) 2022-07-12 15:01:58 -04:00
message_retention_policies.md Remove warnings from the docs about using message retention. (#16382) 2023-09-28 07:02:31 -04:00
metrics-howto.md Include monthly active user metrics in the list of legacy metrics names (#14360) 2022-11-04 10:45:01 +00:00
openid.md Update Mastodon SSO instructions (#15587) 2023-05-15 11:17:24 +02:00
opentracing.md Mention how to redirect the Jaeger traces to a specific Jaeger instance (#16531) 2023-10-23 11:55:36 +00: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 Use dbname instead of database for Postgres config. (#16618) 2023-11-09 14:40:45 -05:00
presence_router_module.md Port the PresenceRouter module interface to the new generic interface (#10524) 2021-08-17 13:22:45 +00:00
replication.md Update code to refer to "workers". (#15606) 2023-05-16 15:56:38 -04:00
reverse_proxy.md Switch UNIX socket paths to /run, and add a UNIX socket example for HAProxy (#16700) 2023-12-04 12:38:46 +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 Remove code generating comments in configuration file (#12941) 2022-06-14 07:53:42 -07:00
sample_log_config.yaml Remove outdated comment in log config (#15648) 2023-05-22 17:58:58 +00:00
server_notices.md Add avatar and topic settings for server notice room (#16679) 2023-12-12 15:22:19 +00: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 Fix broken links in the Synapse documentation. (#14744) 2023-01-05 18:18:00 +00:00
structured_logging.md Add link explaining ELK stack to structured_logging.md (#16091) 2023-08-16 14:08:35 +01: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-up incorrect spellings in docs. (#16282) 2023-09-08 09:47:36 -04:00
templates.md Fix a typo in docs and in some warnings (#13538) 2022-08-17 10:59:05 +01:00
turn-howto.md Fix-up incorrect spellings in docs. (#16282) 2023-09-08 09:47:36 -04:00
upgrade.md Document which versions of Synapse have compatible schema versions. (#16661) 2023-11-28 11:01:24 -05:00
user_directory.md Clean-up old release notes (#16418) 2023-10-02 11:05:29 -04:00
welcome_and_overview.md Switch the 'Configuration' link in the docs homepage to the config manual (#12748) 2022-05-18 11:29:32 +00:00
workers.md Add `/notifications` endpoint to workers (#16265) 2023-09-07 09:26:07 +00:00

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.