MatrixSynapse/docs
realtyem 6acb6d772a
Update worker docs to update preferred settings for pusher and federation_sender (#14493)
* Fix one typo on line 3700(and apparently do something to other lines, no idea)

* Update config_documentation.md with more information about how federation_senders and pushers settings can be handled.

Specifically, that the instance map style of config does not require the special other variables that enable and disable functionality and that a single worker CAN be added to the map not only just two or more.

* Extra line here for consistency and appearance.

* Add link to sygnal repo.

* Add deprecation notice to workers.md and point to the newer alternative method of defining this functionality.

* Changelog

* Correct version number of Synapse the deprecation is happening in.

* Update quiet deprecation with simple notice and suggestion.
2022-12-02 11:38:01 +00:00
..
admin_api Add an Admin API endpoint for looking up users based on 3PID (#14405) 2022-11-11 15:38:17 +00:00
changelogs
development Allow override for requesting specific worker types for Complement on command line. (#14324) 2022-11-08 12:34:09 +00:00
modules
other
privacy_policy_templates/en
setup Cite launchpad bug that says ubuntu's pkgs are old (#14517) 2022-11-30 18:33:35 +00:00
systemd-with-workers Add sample worker files for `pusher` and `federation_sender` (#14077) 2022-10-07 14:25:28 +01:00
usage Update worker docs to update preferred settings for pusher and federation_sender (#14493) 2022-12-02 11:38:01 +00:00
website_files
.sample_config_header.yaml
CAPTCHA_SETUP.md
README.md
SUMMARY.md Include additional TURN server example into documentation (#14293) 2022-11-14 17:55:10 +00:00
ancient_architecture_notes.md
application_services.md
architecture.md
auth_chain_diff.dot
auth_chain_diff.dot.png
auth_chain_difference_algorithm.md
code_style.md
consent_tracking.md
delegate.md
deprecation_policy.md
favicon.png
favicon.svg
federate.md
jwt.md
log_contexts.md
manhole.md
media_repository.md
message_retention_policies.md
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 Support OIDC backchannel logouts (#11414) 2022-10-31 13:07:30 -04:00
opentracing.md
password_auth_providers.md
postgres.md
presence_router_module.md
replication.md
reverse_proxy.md Update sample Nginx configuration to HTTP 1.1 (#14414) 2022-11-11 17:28:05 +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
structured_logging.md
synctl_workers.md
tcp_replication.md
templates.md
turn-howto.md Include additional TURN server example into documentation (#14293) 2022-11-14 17:55:10 +00:00
upgrade.md Remove legacy Prometheus metrics names. They were deprecated in Synapse v1.69.0 and disabled by default in Synapse v1.71.0. (#14538) 2022-11-24 09:09:17 +00:00
user_directory.md
welcome_and_overview.md
workers.md Update worker docs to update preferred settings for pusher and federation_sender (#14493) 2022-12-02 11:38:01 +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.