Vladimir Babin
c0d4a16a11
Fixes #18885. The "Override ratelimiting for users" section of the user admin API docs described `messages_per_second` as "the number of actions that can be performed in a second", which suggests the override applies to every ratelimiter. In the code (`synapse/api/ratelimiting.py`) the override's rate/burst values are only used by the event-sending ratelimiter (`RequestRatelimiter.ratelimit`, i.e. `rc_message`); the generic `Ratelimiter.can_do_action` only reads the override to check whether `messages_per_second` is `0` and, if so, disables ratelimiting entirely for that user. Changes (docs only): - State up front that the override replaces only the message-sending limits (`rc_message`), not `rc_invites`/`rc_joins`/`rc_login` etc., and that `messages_per_second = 0` disables all ratelimiting. - Rename the sub-headings to "Get status of / Set / Delete ratelimit **override**" and describe the fields as messages rather than actions. - Explain that "Delete ratelimit override" restores the global config limits rather than disabling ratelimiting. The `#override-ratelimiting-for-users` anchor referenced elsewhere in the page is unchanged. Verified with `mdbook build` (mdbook 0.5.2, same as `docs-pr.yaml`): renders cleanly, new anchors `#get-status-of-ratelimit-override`, `#set-ratelimit-override`, `#delete-ratelimit-override` present.
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
- Single Sign-On
- User Authentication
- Configuration
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.
Building the documentation requires running some python. Ensure you have set up poetry, then run:
poetry install --only docs --no-root
to install just the python dependencies needed to build the documentation.
Then, install mdbook, which will convert the source markdown to HTML pages.
Finally, from the root of the repository, build the documentation with:
poetry run 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.
Synapse configuration documentation
The Configuration Manual page is generated from a YAML file, schema/synapse-config.schema.yaml. To add new options or modify existing ones, first edit that file, then run scripts-dev/gen_config_documentation.py to generate an updated Configuration Manual markdown file.
Build the book as described above to preview it in a web browser.
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.