Erik Johnston 2e3a83d8d4 Generate sample config 2 سال پیش
..
admin_api 409573f6d0 Fix reference to the wrong symbol in the media admin api docs (#12715) 2 سال پیش
changelogs e31d06f6f0 Split changelogs by year 2 سال پیش
development 18d6c18aa1 Fix docs on how to run specific Complement tests after recent `complement.sh` change (#12664) 2 سال پیش
modules e4409301ba Add a module callback to react to account data changes (#12327) 2 سال پیش
other b4461e7d8a Enable complexity checking in complexity checking docs example (#11998) 2 سال پیش
privacy_policy_templates 22a2004428 Update documentation and templates for new consent 6 سال پیش
setup ec07062e31 Update installation docs to indicate that we support Python 3.10 (#11820) 2 سال پیش
systemd-with-workers a36a38b1ca Add some example configurations for worker (#12492) 2 سال پیش
usage 6d8d1218dd Fix typo in name of 'run_background_tasks_on' option in config manual (#12749) 2 سال پیش
website_files 0922462fc7 docs: Don't render the table of contents on the print page (#12340) 2 سال پیش
.sample_config_header.yaml 974261cd81 Fix broken links in INSTALL.md (#10331) 3 سال پیش
CAPTCHA_SETUP.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 سال پیش
README.md d9e9771d6b Update README.md 3 سال پیش
SUMMARY.md 3c758d9808 Add a manual documenting config file options (#12368) 2 سال پیش
ancient_architecture_notes.md e72135b9d3 change 'Home Server' to one word 'homeserver' (#11320) 3 سال پیش
application_services.md aa2492907f Add some explanation to application_services.md (#7091) 4 سال پیش
architecture.md 379d2a8c39 (#5849) Convert rst to markdown (#6040) 5 سال پیش
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 1315a2e8be Use a chain cover index to efficiently calculate auth chain difference (#8868) 3 سال پیش
code_style.md 535a689cfc Reintroduce the lint targets in the linter script (#12455) 2 سال پیش
consent_tracking.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 سال پیش
delegate.md 71f9966f27 Support for serving server well-known files (#11211) 3 سال پیش
deprecation_policy.md 57ca8ab10f Add notes about dropping support for Python 3.6 and Postgres 9.6. 3 سال پیش
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 ba3fd54bad Remove unstable/unspecced login types. (#12597) 2 سال پیش
log_contexts.md ceab5a4bfa Fix 2 typos in docs/log_contexts.md (#10795) 3 سال پیش
manhole.md e24ff8ebe3 Remove `HomeServer.get_datastore()` (#12031) 2 سال پیش
media_repository.md 7564b8e118 Update the media repository documentation (#11415) 3 سال پیش
message_retention_policies.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 سال پیش
metrics-howto.md 0adc2882c1 Fix broken links in documentation (#10180) 3 سال پیش
openid.md c9fc2c0d22 Update issuer URL in example OIDC Keycloak config (#12727) 2 سال پیش
opentracing.md c14f99be46 Support enabling opentracing by user (#9978) 3 سال پیش
password_auth_providers.md 4ad5ee9996 Correct target of link to the modules page from the Password Auth Providers page (#11309) 3 سال پیش
postgres.md e78d4f61fc Refuse to start if DB has an unsafe locale (#12262) 2 سال پیش
presence_router_module.md 1a9f531c79 Port the PresenceRouter module interface to the new generic interface (#10524) 3 سال پیش
replication.md d80a7ab151 Update `replication.md` with info on TCP module structure (#12621) 2 سال پیش
reverse_proxy.md d9b71410c2 Add HAProxy delegation example to docs (#12501) 2 سال پیش
room_and_user_statistics.md f6767abc05 Remove functionality associated with unused historical stats tables (#9721) 3 سال پیش
sample_config.yaml 2e3a83d8d4 Generate sample config 2 سال پیش
sample_log_config.yaml 8d156ec0ba Remove special-case for `twisted` logger (#12589) 2 سال پیش
server_notices.md c141455049 Docs: Use something other than the document name to describe a page (#10399) 3 سال پیش
spam_checker.md 3fffb71254 Make deprecation notice of the spam checker doc more obvious (#10395) 3 سال پیش
sso_mapping_providers.md 84d790a32e Clarify SSO mapping provider documentation by writing `def` or `async def` before the names of methods, as appropriate. (#11681) 2 سال پیش
structured_logging.md 6902e9ff2b Remove docs for converting a legacy structured logging config. (#12392) 2 سال پیش
synctl_workers.md ece84f2c45 Improve code formatting and fix a few typos in docs (#11221) 3 سال پیش
tcp_replication.md 66f4949e7f Fix deleting pushers when using sharded pushers. (#9465) 3 سال پیش
templates.md e6a106fd5e Implement a Jinja2 filter to extract localparts from email addresses (#12212) 2 سال پیش
turn-howto.md f46b223354 turn-howto: fix some links 2 سال پیش
upgrade.md 699192fc1a Add the `update_user_directory_from_worker` configuration option (superseding `update_user_directory`) to allow a generic worker to be designated as the worker to update the user directory. (#12654) 2 سال پیش
user_directory.md ea20937084 Add an admin API to run background jobs. (#11352) 3 سال پیش
welcome_and_overview.md e564bdd127 Add content to the Synapse documentation intro page (#10990) 3 سال پیش
workers.md 699192fc1a Add the `update_user_directory_from_worker` configuration option (superseding `update_user_directory`) to allow a generic worker to be designated as the worker to update the user directory. (#12654) 2 سال پیش

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.