summary refs log tree commit diff
path: root/docs/usage
diff options
context:
space:
mode:
Diffstat (limited to 'docs/usage')
-rw-r--r--docs/usage/README.md3
-rw-r--r--docs/usage/administration/README.md7
-rw-r--r--docs/usage/configuration/README.md4
-rw-r--r--docs/usage/configuration/sample_config.md28
-rw-r--r--docs/usage/configuration/user_authentication/README.md15
5 files changed, 57 insertions, 0 deletions
diff --git a/docs/usage/README.md b/docs/usage/README.md
new file mode 100644
index 0000000000..5dee2f38c7
--- /dev/null
+++ b/docs/usage/README.md
@@ -0,0 +1,3 @@
+# Usage
+
+This section contains information on how to configure, manage, maintain and administrate your Synapse homeserver and users.
\ No newline at end of file
diff --git a/docs/usage/administration/README.md b/docs/usage/administration/README.md
new file mode 100644
index 0000000000..e1e57546ab
--- /dev/null
+++ b/docs/usage/administration/README.md
@@ -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.
\ No newline at end of file
diff --git a/docs/usage/configuration/README.md b/docs/usage/configuration/README.md
new file mode 100644
index 0000000000..7d3f586da3
--- /dev/null
+++ b/docs/usage/configuration/README.md
@@ -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).
\ No newline at end of file
diff --git a/docs/usage/configuration/sample_config.md b/docs/usage/configuration/sample_config.md
new file mode 100644
index 0000000000..f826de8b85
--- /dev/null
+++ b/docs/usage/configuration/sample_config.md
@@ -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}}
+```
diff --git a/docs/usage/configuration/user_authentication/README.md b/docs/usage/configuration/user_authentication/README.md
new file mode 100644
index 0000000000..087ae053cf
--- /dev/null
+++ b/docs/usage/configuration/user_authentication/README.md
@@ -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.
\ No newline at end of file