diff --git a/README.md b/README.md index 56da20ce..3ba9f792 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,9 @@ tracking](https://element-hq.github.io/synapse/latest/consent_tracking.html) We'll use Synapse, using the workers architecture to make it scalable, flexible and reusable. +Installation and configuration are documented under `synapse`, "monolithic" +for the standard installation, and "workers" for the advanced configuration. + ## Logging diff --git a/synapse/monolithic/README.md b/synapse/monolithic/README.md new file mode 100644 index 00000000..711116e2 --- /dev/null +++ b/synapse/monolithic/README.md @@ -0,0 +1,10 @@ +--- +gitea: none +include_toc: true +--- + +# Standard, monolithic configuration + +This configuration will be enough for most installations. + + diff --git a/synapse/workers/README.md b/synapse/workers/README.md new file mode 100644 index 00000000..3e93b673 --- /dev/null +++ b/synapse/workers/README.md @@ -0,0 +1,11 @@ +--- +gitea: none +include_toc: true +--- + +# Advanced configuration with workers + +This configuration allows optimizing performance, meant for big, busy +installations. + +