0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-14 16:03:51 +01:00
synapse/docs
Quentin Gliech cdd5979129
Replace isort and black with ruff (#17620)
Ruff now has decent parity with black and isort, so this is going to just save us a bunch of time
2024-08-30 10:07:46 +02:00
..
admin_api Allow enabling sliding sync per-user (#17393) 2024-07-05 13:04:27 +01:00
changelogs Add links to pre-1.0 changelog issue/PR references. (#16638) 2023-11-15 13:31:24 +00:00
development Sliding Sync: Use stream_ordering based timeline pagination for incremental sync (#17510) 2024-08-07 11:27:50 -05:00
modules Fix joining remote rooms when a on_new_event callback is registered (#16973) 2024-03-06 16:00:20 +01:00
other Fix broken links on docs (#16853) 2024-02-06 09:26:55 +00:00
privacy_policy_templates/en
setup Add Red Hat Enterprise Linux and Rocky Linux installation instructions (#17423) 2024-07-11 14:02:19 +01:00
systemd-with-workers Add RuntimeDirectory to matrix-synapse.service (#17084) 2024-04-26 09:56:20 +01:00
usage docs: fix typo in saml2_config example (#17594) 2024-08-29 10:39:16 +00:00
website_files Sort versions in the documentation version picker appropriately. (#16966) 2024-03-14 15:18:51 +00:00
.sample_config_header.yaml Fix sample config doc CI (#16758) 2023-12-21 13:31:19 +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
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
CAPTCHA_SETUP.md Improve code formatting and fix a few typos in docs (#11221) 2021-11-01 11:35:55 +00:00
code_style.md Replace isort and black with ruff (#17620) 2024-08-30 10:07:46 +02:00
consent_tracking.md Fix typo 2023-12-13 16:37:10 +00: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
element_logo_white_bg.svg Upload new logo with white bg and update readme to use it (#17387) 2024-07-10 14:59:24 +01:00
favicon.png
favicon.svg
federate.md Update book location 2023-12-13 16:15:22 +00: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 Update documentation to refer to element-hq. 2023-12-13 15:16:48 +00:00
media_repository.md Inline URL preview documentation. (#13261) 2022-07-12 15:01:58 -04:00
message_retention_policies.md Fix various typos in docs (#17114) 2024-04-26 18:10:45 +00:00
metrics-howto.md Fix typo 2023-12-13 16:37:10 +00:00
openid.md Update Lemonldap-NG OIDC config (#17204) 2024-05-22 12:29:31 +00: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 Automatically apply SQL for inconsistent sequence (#17305) 2024-06-14 16:40:29 +01:00
presence_router_module.md Port the PresenceRouter module interface to the new generic interface (#10524) 2021-08-17 13:22:45 +00:00
README.md Update book location 2023-12-13 16:15:22 +00:00
replication.md Update code to refer to "workers". (#15606) 2023-05-16 15:56:38 -04:00
reverse_proxy.md Add HAProxy example for single port operation (#16768) 2024-02-20 16:15:58 +00:00
room_and_user_statistics.md
sample_config.yaml Update book location 2023-12-13 16:15:22 +00:00
sample_log_config.yaml Update book location 2023-12-13 16:15:22 +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
sso_mapping_providers.md Apply user email & picture during OIDC registration if present & selected (#17120) 2024-04-29 15:23:05 +00:00
structured_logging.md Add link explaining ELK stack to structured_logging.md (#16091) 2023-08-16 14:08:35 +01:00
SUMMARY.md Add new module API for adding custom fields to events unsigned section (#16549) 2023-10-27 09:04:08 +00: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 typo 2023-12-13 16:37:10 +00:00
turn-howto.md Fix-up incorrect spellings in docs. (#16282) 2023-09-08 09:47:36 -04:00
upgrade.md Note the new federated media worker endpoints in the worker docs & upgrade notes (#17421) 2024-07-09 16:41:51 +01:00
user_directory.md Fix various typos in docs (#17114) 2024-04-26 18:10:45 +00:00
welcome_and_overview.md Fix outdated Security Disclosure Policy references (#17341) 2024-06-25 15:58:30 +01:00
workers.md Note the new federated media worker endpoints in the worker docs & upgrade notes (#17421) 2024-07-09 16:41:51 +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.