MatrixSynapse/docs
realtyem 58214dbb9b
Allow enabling the asyncio reactor in complement (#14858)
Signed-off-by: Jason Little realtyem@gmail.com
2023-02-01 23:42:45 +00:00
..
admin_api Fix broken links in the Synapse documentation. (#14744) 2023-01-05 18:18:00 +00:00
changelogs
development Allow enabling the asyncio reactor in complement (#14858) 2023-02-01 23:42:45 +00:00
modules Fix broken links in the Synapse documentation. (#14744) 2023-01-05 18:18:00 +00:00
other
privacy_policy_templates/en
setup Fix broken links in the Synapse documentation. (#14744) 2023-01-05 18:18:00 +00:00
systemd-with-workers Include `x_forwarded` in workers example configs (#14667) 2023-01-13 14:06:58 +00:00
usage Add more user information to export-data command. (#14894) 2023-02-01 15:45:19 +00:00
website_files
.sample_config_header.yaml
CAPTCHA_SETUP.md
README.md
SUMMARY.md Initial batch of notes on faster joins (#14677) 2023-01-30 21:27:52 +00:00
ancient_architecture_notes.md
application_services.md Fix missing field in AS documentation (#14845) 2023-01-16 12:59:15 +00:00
architecture.md
auth_chain_diff.dot
auth_chain_diff.dot.png
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
delegate.md
deprecation_policy.md Define SQLite compat policy (#13728) 2022-09-07 12:07:42 +00:00
favicon.png
favicon.svg
federate.md
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
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 Add a warning to retention documentation regarding the possibility of database corruption (#13497) 2022-08-15 11:54:23 -07: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 Fix broken links in the Synapse documentation. (#14744) 2023-01-05 18:18:00 +00:00
opentracing.md
password_auth_providers.md
postgres.md Fix broken links in the Synapse documentation. (#14744) 2023-01-05 18:18:00 +00:00
presence_router_module.md
replication.md
reverse_proxy.md Broken link "request_id_header" (#14740) 2022-12-28 15:45:28 +00:00
room_and_user_statistics.md
sample_config.yaml
sample_log_config.yaml Add workers settings to configuration manual (#14086) 2022-10-27 14:39:47 +01:00
server_notices.md
spam_checker.md
sso_mapping_providers.md Fix broken links in the Synapse documentation. (#14744) 2023-01-05 18:18:00 +00:00
structured_logging.md
synctl_workers.md
tcp_replication.md
templates.md Fix a typo in docs and in some warnings (#13538) 2022-08-17 10:59:05 +01:00
turn-howto.md Change `turn_allow_guests` example value to lowercase `true` (#14634) 2022-12-07 11:33:24 +00:00
upgrade.md update changelog and upgrade notes 2023-01-31 08:35:22 -08:00
user_directory.md
welcome_and_overview.md
workers.md Add missing worker settings to shared configuration (#14748) 2023-01-09 18:35:19 +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.