Erik Johnston e85e0ef6ba Merge remote-tracking branch 'origin/master' into develop преди 5 месеца
..
admin_api 518e4de758 Update admin user API return types in docs. (#16654) преди 6 месеца
changelogs 80922dc46e Add links to pre-1.0 changelog issue/PR references. (#16638) преди 6 месеца
development 8751f0ef32 Fix poetry version typo in contributors' guide (#16695) преди 5 месеца
modules 63d96bfc61 ModuleAPI SSO auth callbacks (#15207) преди 5 месеца
other b4461e7d8a Enable complexity checking in complexity checking docs example (#11998) преди 2 години
privacy_policy_templates 22a2004428 Update documentation and templates for new consent преди 5 години
setup 39dc5de399 docs: Link to the Alpine Linux community package for Synapse (#16304) преди 8 месеца
systemd-with-workers 677272caed Remove `worker_replication_*` settings from worker doc (#15872) преди 10 месеца
usage e108cde669 Sentry Alert configuration based on production and development environment (#16738) преди 5 месеца
website_files e85e0ef6ba Merge remote-tracking branch 'origin/master' into develop преди 5 месеца
.sample_config_header.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) преди 1 година
CAPTCHA_SETUP.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) преди 2 години
README.md d9e9771d6b Update README.md преди 2 години
SUMMARY.md c02406ac71 Add new module API for adding custom fields to events `unsigned` section (#16549) преди 7 месеца
ancient_architecture_notes.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) преди 8 месеца
application_services.md 7801fd74da Fix missing field in AS documentation (#14845) преди 1 година
architecture.md 379d2a8c39 (#5849) Convert rst to markdown (#6040) преди 4 години
auth_chain_diff.dot 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) преди 3 години
auth_chain_diff.dot.png 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) преди 3 години
auth_chain_difference_algorithm.md a25a37002c Write about the chain cover a little. (#13602) преди 1 година
code_style.md f4d2a734f9 Remove outdated commands from the code style doc & point to the contributing guide. (#14773) преди 1 година
consent_tracking.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) преди 8 месеца
delegate.md 85d93d003c Clarify limitations of SRV delegation in documentation (#14959) преди 1 година
deprecation_policy.md 5e82b07d2c Drop debian buster (#15893) преди 10 месеца
favicon.png fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) преди 3 години
favicon.svg fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) преди 3 години
federate.md 9a0172d49f Clean-up demo scripts & documentation (#12143) преди 2 години
jwt.md 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) преди 1 година
log_contexts.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) преди 8 месеца
manhole.md 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) преди 1 година
media_repository.md 1381563988 Inline URL preview documentation. (#13261) преди 1 година
message_retention_policies.md fb664cf159 Remove warnings from the docs about using message retention. (#16382) преди 7 месеца
metrics-howto.md 78909f5028 Include monthly active user metrics in the list of legacy metrics names (#14360) преди 1 година
openid.md aa5c0592e7 Update Mastodon SSO instructions (#15587) преди 1 година
opentracing.md 3bcb6a059f Mention how to redirect the Jaeger traces to a specific Jaeger instance (#16531) преди 7 месеца
password_auth_providers.md 4ad5ee9996 Correct target of link to the modules page from the Password Auth Providers page (#11309) преди 2 години
postgres.md bc4372ad81 Use dbname instead of database for Postgres config. (#16618) преди 6 месеца
presence_router_module.md 1a9f531c79 Port the PresenceRouter module interface to the new generic interface (#10524) преди 2 години
replication.md 375b0a8a11 Update code to refer to "workers". (#15606) преди 1 година
reverse_proxy.md 0aa4d3b6f7 Switch UNIX socket paths to /run, and add a UNIX socket example for HAProxy (#16700) преди 5 месеца
room_and_user_statistics.md f6767abc05 Remove functionality associated with unused historical stats tables (#9721) преди 2 години
sample_config.yaml 493c2fc44a Remove code generating comments in configuration file (#12941) преди 1 година
sample_log_config.yaml 737f7ddf58 Remove outdated comment in log config (#15648) преди 1 година
server_notices.md e108c31fc0 Add avatar and topic settings for server notice room (#16679) преди 5 месеца
spam_checker.md 3fffb71254 Make deprecation notice of the spam checker doc more obvious (#10395) преди 2 години
sso_mapping_providers.md 4eb2f4e02b Fix broken links in the Synapse documentation. (#14744) преди 1 година
structured_logging.md 4513b36a75 Add link explaining ELK stack to structured_logging.md (#16091) преди 9 месеца
synctl_workers.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) преди 2 години
tcp_replication.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) преди 8 месеца
templates.md b71b41c7bd Fix a typo in docs and in some warnings (#13538) преди 1 година
turn-howto.md 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) преди 8 месеца
upgrade.md 77882b6a7d Document which versions of Synapse have compatible schema versions. (#16661) преди 5 месеца
user_directory.md 127b940dc0 Clean-up old release notes (#16418) преди 7 месеца
welcome_and_overview.md a167304c8b Switch the 'Configuration' link in the docs homepage to the config manual (#12748) преди 2 години
workers.md 8940d1b28e Add `/notifications` endpoint to workers (#16265) преди 8 месеца

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.