anonymousland-synapse/docs
Will Hunt a933c2c7d8
Add an admin API to check if a username is available (#10578)
This adds a new API GET /_synapse/admin/v1/username_available?username=foo to check if a username is available. It is the counterpart to https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-register-available, except that it works even if registration is disabled.
2021-08-17 10:52:38 +01:00
..
admin_api Add an admin API to check if a username is available (#10578) 2021-08-17 10:52:38 +01:00
development Add developer documentation to explain room DAG concepts like outliers and state_groups (#10464) 2021-08-03 10:08:57 +00:00
privacy_policy_templates/en Update documentation and templates for new consent 2018-10-12 17:53:14 -06:00
setup support federation queries through http connect proxy (#10475) 2021-08-11 15:34:59 +01:00
systemd-with-workers Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
usage Fix some links in docs and contrib (#10370) 2021-07-13 11:55:48 +01:00
website_files Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00
.sample_config_header.yaml Fix broken links in INSTALL.md (#10331) 2021-07-08 15:46:13 +01:00
ancient_architecture_notes.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
application_services.md Add some explanation to application_services.md (#7091) 2020-04-27 15:03:09 +01:00
architecture.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
auth_chain_diff.dot Use a chain cover index to efficiently calculate auth chain difference (#8868) 2021-01-11 16:09:22 +00:00
auth_chain_diff.dot.png Use a chain cover index to efficiently calculate auth chain difference (#8868) 2021-01-11 16:09:22 +00:00
auth_chain_difference_algorithm.md Use a chain cover index to efficiently calculate auth chain difference (#8868) 2021-01-11 16:09:22 +00:00
CAPTCHA_SETUP.md Update CAPTCHA documentation to mention turning off verify origin feature (#10046) 2021-05-26 10:55:30 +01:00
code_style.md Replace room_invite_state_types with room_prejoin_state (#9700) 2021-03-30 12:12:44 +01:00
consent_tracking.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
delegate.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
deprecation_policy.md Add deprecation policy doc (#9723) 2021-04-06 13:07:36 +01:00
favicon.png Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00
favicon.svg Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00
federate.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
jwt.md Return the proper 403 Forbidden error during errors with JWT logins. (#7844) 2020-07-15 07:10:21 -04:00
log_contexts.md Update the logcontext doc (#10353) 2021-07-15 11:38:05 +01:00
manhole.md Manhole: wrap coroutines in defer.ensureDeferred automatically (#10602) 2021-08-16 18:11:48 +01:00
media_repository.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
message_retention_policies.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
metrics-howto.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
modules.md Port the ThirdPartyEventRules module interface to the new generic interface (#10386) 2021-07-20 12:39:46 +02:00
MSC1711_certificates_FAQ.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
openid.md Fix the hierarchy of OpenID providers in the docs. (#10445) 2021-07-21 13:48:06 -04:00
opentracing.md Support enabling opentracing by user (#9978) 2021-05-14 10:51:08 +01:00
password_auth_providers.md Fix typo in password_auth_providers doc 2020-12-01 10:34:52 +00:00
postgres.md Fix broken links in INSTALL.md (#10331) 2021-07-08 15:46:13 +01:00
presence_router_module.md Fix the homeserver config example in presence router docs (#10288) 2021-06-30 23:43:58 +01:00
README.md Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00
replication.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
reverse_proxy.md Moved homeserver documentation above reverse proxy examples (#10551) 2021-08-09 15:12:53 +00:00
room_and_user_statistics.md Remove functionality associated with unused historical stats tables (#9721) 2021-07-08 16:57:13 +01:00
sample_config.yaml Add a setting to disable TLS for sending email (#10546) 2021-08-06 10:13:34 +00:00
sample_log_config.yaml Revert use of PeriodicallyFlushingMemoryHandler by default (#10515) 2021-08-03 11:30:39 +01:00
server_notices.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00
spam_checker.md Make deprecation notice of the spam checker doc more obvious (#10395) 2021-07-15 15:54:22 +02:00
sso_mapping_providers.md Fix broken links in documentation (#10180) 2021-06-16 13:15:52 +01:00
structured_logging.md Support generating structured logs in addition to standard logs. (#8607) 2020-10-29 07:27:37 -04:00
SUMMARY.md Add documentation for configuring a forward proxy. (#10443) 2021-08-05 07:20:05 -04:00
synctl_workers.md Update worker docs with recent enhancements (#7969) 2020-07-29 23:22:13 +01:00
tcp_replication.md Fix deleting pushers when using sharded pushers. (#9465) 2021-02-22 21:14:42 +00:00
turn-howto.md Make link in docs use HTTPS (#10130) 2021-06-07 16:35:02 +01:00
upgrade.md support federation queries through http connect proxy (#10475) 2021-08-11 15:34:59 +01:00
url_previews.md move url_previews to MD as RST does my head in 2017-10-29 20:47:17 +00:00
user_directory.md Update user_directory.md (#10016) 2021-05-20 14:24:19 +01:00
welcome_and_overview.md Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00
workers.md Docs: Use something other than the document name to describe a page (#10399) 2021-07-15 12:47:55 +01:00

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 reference Matrix homeserver. 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. You can browse the book by opening book/index.html in a web browser.

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.