Matrix-Mirrors/anonymousland-synapse
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse.git synced 2025-08-01 15:56:02 -04:00
Code Issues Projects Releases Packages Wiki Activity

Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)

Browse source
This commit is contained in:
Andrew Morgan 2021-06-03 17:20:40 +01:00 • committed by GitHub
parent 9eea4646be
commit fd9856e4a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
35 changed files with 979 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/usage/configuration/README.md Normal file
View file

@ -0,0 +1,4 @@
# Configuration
This section contains information on tweaking Synapse via the various options in the configuration file. A configuration
file should have been generated when you [installed Synapse](../../setup/installation.html).

14
docs/usage/configuration/homeserver_sample_config.md Normal file
View file

@ -0,0 +1,14 @@
# Homeserver Sample Configuration File
Below is a sample homeserver configuration file. The homeserver configuration file
can be tweaked to change the behaviour of your homeserver. A restart of the server is
generally required to apply any changes made to this file.
Note that the contents below are *not* intended to be copied and used as the basis for
a real homeserver.yaml. Instead, if you are starting from scratch, please generate
a fresh config using Synapse by following the instructions in
[Installation](../../setup/installation.md).
```yaml
{{#include ../../sample_config.yaml}}
```

14
docs/usage/configuration/logging_sample_config.md Normal file
View file

@ -0,0 +1,14 @@
# Logging Sample Configuration File
Below is a sample logging configuration file. This file can be tweaked to control how your
homeserver will output logs. A restart of the server is generally required to apply any
changes made to this file.
Note that the contents below are *not* intended to be copied and used as the basis for
a real homeserver.yaml. Instead, if you are starting from scratch, please generate
a fresh config using Synapse by following the instructions in
[Installation](../../setup/installation.md).
```yaml
{{#include ../../sample_log_config.yaml}}
``__`

15
docs/usage/configuration/user_authentication/README.md Normal file
View file

@ -0,0 +1,15 @@
# User Authentication
Synapse supports multiple methods of authenticating users, either out-of-the-box or through custom pluggable
authentication modules.
Included in Synapse is support for authenticating users via:
* A username and password.
* An email address and password.
* Single Sign-On through the SAML, Open ID Connect or CAS protocols.
* JSON Web Tokens.
* An administrator's shared secret.
Synapse can additionally be extended to support custom authentication schemes through optional "password auth provider"
modules.