Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.
 
 
 
 
 
 
reivilibre e937e2111a
Add the ability to use `G` (GiB) and `T` (TiB) suffixes in configuration options that refer to numbers of bytes. (#16219)
8 mesi fa
..
admin_api Add last_seen_ts to the admin users API (#16218) 8 mesi fa
changelogs Split out 2022 changes from the changelog (#15846) 10 mesi fa
development Update URLs to matrix.org blog categories. (#16008) 9 mesi fa
modules Add login spam checker API (#15838) 10 mesi fa
other Enable complexity checking in complexity checking docs example (#11998) 2 anni fa
privacy_policy_templates/en Update documentation and templates for new consent 5 anni fa
setup Fix broken Arch Linux package link (#15981) 10 mesi fa
systemd-with-workers Remove `worker_replication_*` settings from worker doc (#15872) 10 mesi fa
usage Add the ability to use `G` (GiB) and `T` (TiB) suffixes in configuration options that refer to numbers of bytes. (#16219) 8 mesi fa
website_files docs: Don't render the table of contents on the print page (#12340) 2 anni fa
.sample_config_header.yaml Remove code generating comments in configuration file (#12941) 1 anno fa
CAPTCHA_SETUP.md Improve code formatting and fix a few typos in docs (#11221) 2 anni fa
README.md Update README.md 2 anni fa
SUMMARY.md Add notes describing Synapse's streams (#16015) 9 mesi fa
ancient_architecture_notes.md change 'Home Server' to one word 'homeserver' (#11320) 2 anni fa
application_services.md Fix missing field in AS documentation (#14845) 1 anno fa
architecture.md (#5849) Convert rst to markdown (#6040) 4 anni fa
auth_chain_diff.dot Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 anni fa
auth_chain_diff.dot.png Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 anni fa
auth_chain_difference_algorithm.md Write about the chain cover a little. (#13602) 1 anno fa
code_style.md Remove outdated commands from the code style doc & point to the contributing guide. (#14773) 1 anno fa
consent_tracking.md Improve code formatting and fix a few typos in docs (#11221) 2 anni fa
delegate.md Clarify limitations of SRV delegation in documentation (#14959) 1 anno fa
deprecation_policy.md Drop debian buster (#15893) 10 mesi fa
favicon.png Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 anni fa
favicon.svg Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 anni fa
federate.md Clean-up demo scripts & documentation (#12143) 2 anni fa
jwt.md Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 1 anno fa
log_contexts.md Fix 2 typos in docs/log_contexts.md (#10795) 2 anni fa
manhole.md Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 1 anno fa
media_repository.md Inline URL preview documentation. (#13261) 1 anno fa
message_retention_policies.md Add a warning to retention documentation regarding the possibility of database corruption (#13497) 1 anno fa
metrics-howto.md Include monthly active user metrics in the list of legacy metrics names (#14360) 1 anno fa
openid.md Update Mastodon SSO instructions (#15587) 1 anno fa
opentracing.md Update opentracing docs to reference the configuration manual rather than the configuation file. (#13076) 1 anno fa
password_auth_providers.md Correct target of link to the modules page from the Password Auth Providers page (#11309) 2 anni fa
postgres.md Fix broken links in the Synapse documentation. (#14744) 1 anno fa
presence_router_module.md Port the PresenceRouter module interface to the new generic interface (#10524) 2 anni fa
replication.md Update code to refer to "workers". (#15606) 1 anno fa
reverse_proxy.md Do not expose Admin API in caddy reverse proxy example (#16027) 9 mesi fa
room_and_user_statistics.md Remove functionality associated with unused historical stats tables (#9721) 2 anni fa
sample_config.yaml Remove code generating comments in configuration file (#12941) 1 anno fa
sample_log_config.yaml Remove outdated comment in log config (#15648) 1 anno fa
server_notices.md Docs: Use something other than the document name to describe a page (#10399) 2 anni fa
spam_checker.md Make deprecation notice of the spam checker doc more obvious (#10395) 2 anni fa
sso_mapping_providers.md Fix broken links in the Synapse documentation. (#14744) 1 anno fa
structured_logging.md Add link explaining ELK stack to structured_logging.md (#16091) 9 mesi fa
synctl_workers.md Improve code formatting and fix a few typos in docs (#11221) 2 anni fa
tcp_replication.md Add some clarification to the doc/comments regarding TCP replication (#15354) 1 anno fa
templates.md Fix a typo in docs and in some warnings (#13538) 1 anno fa
turn-howto.md Change `turn_allow_guests` example value to lowercase `true` (#14634) 1 anno fa
upgrade.md Bump minimum supported Rust version to 1.61.0 (#16248) 8 mesi fa
user_directory.md Add an admin API to run background jobs. (#11352) 2 anni fa
welcome_and_overview.md Switch the 'Configuration' link in the docs homepage to the config manual (#12748) 2 anni fa
workers.md Re-introduce the outbound federation proxy (#15913) 10 mesi fa

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.