MatrixSynapse/docs
reivilibre e937e2111a
Add the ability to use `G` (GiB) and `T` (TiB) suffixes in configuration options that refer to numbers of bytes. (#16219)
* Add more suffixes to `parse_size`

* Newsfile

Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>

---------

Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
2023-09-06 14:01:10 +01:00
..
admin_api Add last_seen_ts to the admin users API (#16218) 2023-09-04 18:13:28 +02:00
changelogs Split out 2022 changes from the changelog (#15846) 2023-06-28 15:10:33 -05:00
development Update URLs to matrix.org blog categories. (#16008) 2023-08-24 11:06:06 -04:00
modules Add login spam checker API (#15838) 2023-06-26 14:12:20 +00:00
other
privacy_policy_templates/en
setup Fix broken Arch Linux package link (#15981) 2023-07-24 09:06:10 -04:00
systemd-with-workers Remove `worker_replication_*` settings from worker doc (#15872) 2023-07-07 08:09:41 +00:00
usage Add the ability to use `G` (GiB) and `T` (TiB) suffixes in configuration options that refer to numbers of bytes. (#16219) 2023-09-06 14:01:10 +01:00
website_files
.sample_config_header.yaml
CAPTCHA_SETUP.md
README.md
SUMMARY.md Add notes describing Synapse's streams (#16015) 2023-08-07 18:36:04 +01: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 Drop debian buster (#15893) 2023-07-10 10:39:36 -07:00
favicon.png
favicon.svg
federate.md
jwt.md
log_contexts.md
manhole.md
media_repository.md
message_retention_policies.md
metrics-howto.md
openid.md
opentracing.md
password_auth_providers.md
postgres.md
presence_router_module.md
replication.md
reverse_proxy.md Do not expose Admin API in caddy reverse proxy example (#16027) 2023-07-31 13:25:06 +02:00
room_and_user_statistics.md
sample_config.yaml
sample_log_config.yaml
server_notices.md
spam_checker.md
sso_mapping_providers.md
structured_logging.md Add link explaining ELK stack to structured_logging.md (#16091) 2023-08-16 14:08:35 +01:00
synctl_workers.md
tcp_replication.md
templates.md
turn-howto.md
upgrade.md Bump minimum supported Rust version to 1.61.0 (#16248) 2023-09-05 13:12:50 +01:00
user_directory.md
welcome_and_overview.md
workers.md Re-introduce the outbound federation proxy (#15913) 2023-07-18 09:49:21 +01: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.