Add some section pages
These pages simply act as a container for other pages, but also serve to provide an introduction and explanation for the pages to come. We can also use it to describe what topics should be covered in the section, to help others organise new documentation pages.
This commit is contained in:
3
docs/usage/README.md
Normal file
3
docs/usage/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Usage
|
||||
|
||||
This section contains information on how to configure, manage, maintain and administrate your Synapse homeserver and users.
|
||||
7
docs/usage/administration/README.md
Normal file
7
docs/usage/administration/README.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Administration
|
||||
|
||||
This section contains information on managing your Synapse homeserver. This includes:
|
||||
|
||||
* Managing users, rooms and media via the Admin API.
|
||||
* Setting up metrics and monitoring to give you insight into your homeserver's health.
|
||||
* Configuring structured logging.
|
||||
4
docs/usage/configuration/README.md
Normal file
4
docs/usage/configuration/README.md
Normal 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).
|
||||
28
docs/usage/configuration/sample_config.md
Normal file
28
docs/usage/configuration/sample_config.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Sample Configuration Files
|
||||
|
||||
## Homeserver Config
|
||||
|
||||
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).
|
||||
|
||||
A sample logging config file is provided in [the next section](#logging-config).
|
||||
|
||||
|
||||
```yaml
|
||||
{{#include ../../sample_config.yaml}}
|
||||
```
|
||||
|
||||
## Logging Config
|
||||
|
||||
Below is a sample logging configuration file. This file controls how your homeserver
|
||||
will output logs.
|
||||
|
||||
```yaml
|
||||
{{#include ../../sample_log_config.yaml}}
|
||||
```
|
||||
15
docs/usage/configuration/user_authentication/README.md
Normal file
15
docs/usage/configuration/user_authentication/README.md
Normal 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.
|
||||
Reference in New Issue
Block a user