Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add an index to config manual #12527

Merged
merged 3 commits into from
Apr 25, 2022
Merged

Add an index to config manual #12527

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bfcc917
add index
H-Shay Apr 22, 2022
d92b5ab
newsfragment
H-Shay Apr 22, 2022
7eb9456
Update config_documentation.md
H-Shay Apr 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog.d/12527.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add an index to the configuration manual.

44 changes: 43 additions & 1 deletion docs/usage/configuration/config_documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,49 @@ apply if you want your config file to be read properly. A few helpful things to
In addition, each setting has an example of its usage, with the proper indentation
shown.


## Index
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I think this might be a table of contents rather than an index?

[Modules](#modules)

[Server](#server)

[Homeserver Blocking](#homeserver-blocking)

[TLS](#tls)

[Federation](#federation)

[Caching](#caching)

[Database](#database)

[Logging](#logging)

[Ratelimiting](#ratelimiting)

[Media Store](#media-store)

[Captcha](#captcha)

[TURN](#turn)

[Registration](#registration)

[API Configuration](#api-configuration)

[Signing Keys](#signing-keys)

[Single Sign On Integration](#single-sign-on-integration)

[Push](#push)

[Rooms](#rooms)

[Opentracing](#opentracing)

[Workers](#workers)

[Background Updates](#background-updates)

## Modules

Server admins can expand Synapse's functionality with external modules.
Expand Down