Laurence Gill 166ffc0f23 Fix typo in useful_sql_for_admins.md (#16477) 7 tháng trước cách đây
..
admin_api 5725712d47 Remove Python version from `/_synapse/admin/v1/server_version` (#16380) 7 tháng trước cách đây
changelogs 127b940dc0 Clean-up old release notes (#16418) 7 tháng trước cách đây
development 694802eecd Add documentation on background updates. (#16420) 7 tháng trước cách đây
modules 25c55a9d22 Add login spam checker API (#15838) 11 tháng trước cách đây
other b4461e7d8a Enable complexity checking in complexity checking docs example (#11998) 2 năm trước cách đây
privacy_policy_templates 22a2004428 Update documentation and templates for new consent 5 năm trước cách đây
setup 39dc5de399 docs: Link to the Alpine Linux community package for Synapse (#16304) 8 tháng trước cách đây
systemd-with-workers 677272caed Remove `worker_replication_*` settings from worker doc (#15872) 10 tháng trước cách đây
usage 166ffc0f23 Fix typo in useful_sql_for_admins.md (#16477) 7 tháng trước cách đây
website_files 0922462fc7 docs: Don't render the table of contents on the print page (#12340) 2 năm trước cách đây
.sample_config_header.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) 1 năm trước cách đây
CAPTCHA_SETUP.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 2 năm trước cách đây
README.md d9e9771d6b Update README.md 2 năm trước cách đây
SUMMARY.md 9d3713d6d5 Add notes describing Synapse's streams (#16015) 9 tháng trước cách đây
ancient_architecture_notes.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) 8 tháng trước cách đây
application_services.md 7801fd74da Fix missing field in AS documentation (#14845) 1 năm trước cách đây
architecture.md 379d2a8c39 (#5849) Convert rst to markdown (#6040) 4 năm trước cách đây
auth_chain_diff.dot 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 năm trước cách đây
auth_chain_diff.dot.png 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 năm trước cách đây
auth_chain_difference_algorithm.md a25a37002c Write about the chain cover a little. (#13602) 1 năm trước cách đây
code_style.md f4d2a734f9 Remove outdated commands from the code style doc & point to the contributing guide. (#14773) 1 năm trước cách đây
consent_tracking.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) 8 tháng trước cách đây
delegate.md 85d93d003c Clarify limitations of SRV delegation in documentation (#14959) 1 năm trước cách đây
deprecation_policy.md 5e82b07d2c Drop debian buster (#15893) 10 tháng trước cách đây
favicon.png fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 năm trước cách đây
favicon.svg fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 3 năm trước cách đây
federate.md 9a0172d49f Clean-up demo scripts & documentation (#12143) 2 năm trước cách đây
jwt.md 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 1 năm trước cách đây
log_contexts.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) 8 tháng trước cách đây
manhole.md 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 1 năm trước cách đây
media_repository.md 1381563988 Inline URL preview documentation. (#13261) 1 năm trước cách đây
message_retention_policies.md fb664cf159 Remove warnings from the docs about using message retention. (#16382) 8 tháng trước cách đây
metrics-howto.md 78909f5028 Include monthly active user metrics in the list of legacy metrics names (#14360) 1 năm trước cách đây
openid.md aa5c0592e7 Update Mastodon SSO instructions (#15587) 1 năm trước cách đây
opentracing.md 3d94d07db3 Update opentracing docs to reference the configuration manual rather than the configuation file. (#13076) 1 năm trước cách đây
password_auth_providers.md 4ad5ee9996 Correct target of link to the modules page from the Password Auth Providers page (#11309) 2 năm trước cách đây
postgres.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) 8 tháng trước cách đây
presence_router_module.md 1a9f531c79 Port the PresenceRouter module interface to the new generic interface (#10524) 2 năm trước cách đây
replication.md 375b0a8a11 Update code to refer to "workers". (#15606) 1 năm trước cách đây
reverse_proxy.md e02f4b7de2 Do not expose Admin API in caddy reverse proxy example (#16027) 10 tháng trước cách đây
room_and_user_statistics.md f6767abc05 Remove functionality associated with unused historical stats tables (#9721) 2 năm trước cách đây
sample_config.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) 1 năm trước cách đây
sample_log_config.yaml 737f7ddf58 Remove outdated comment in log config (#15648) 1 năm trước cách đây
server_notices.md c141455049 Docs: Use something other than the document name to describe a page (#10399) 2 năm trước cách đây
spam_checker.md 3fffb71254 Make deprecation notice of the spam checker doc more obvious (#10395) 2 năm trước cách đây
sso_mapping_providers.md 4eb2f4e02b Fix broken links in the Synapse documentation. (#14744) 1 năm trước cách đây
structured_logging.md 4513b36a75 Add link explaining ELK stack to structured_logging.md (#16091) 9 tháng trước cách đây
synctl_workers.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 2 năm trước cách đây
tcp_replication.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) 8 tháng trước cách đây
templates.md b71b41c7bd Fix a typo in docs and in some warnings (#13538) 1 năm trước cách đây
turn-howto.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) 8 tháng trước cách đây
upgrade.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) 8 tháng trước cách đây
user_directory.md 127b940dc0 Clean-up old release notes (#16418) 7 tháng trước cách đây
welcome_and_overview.md a167304c8b Switch the 'Configuration' link in the docs homepage to the config manual (#12748) 2 năm trước cách đây
workers.md 8940d1b28e Add `/notifications` endpoint to workers (#16265) 8 tháng trước cách đây

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.