diff --git a/README.md b/README.md index 7c22b3692..4c9e447ac 100644 --- a/README.md +++ b/README.md @@ -69,8 +69,9 @@ $ ./bin/generate-keys --private-key matrix_key.pem # needed for Matrix federation/clients to work properly!) $ ./bin/generate-keys --tls-cert server.crt --tls-key server.key -# Copy and modify the config file - you'll need to set a server name and paths to the keys -# at the very least, along with setting up the database connection strings. +# Copy and modify the config file (samples are in docs/dendrite) - you'll +# need to set a server name and paths to the keys at the very least, along +# with setting up the database connection strings. $ cp dendrite-sample.monolith.yaml dendrite.yaml # Build and run the server: diff --git a/docs/dendrite/README.md b/docs/dendrite/README.md new file mode 100644 index 000000000..f4cda824b --- /dev/null +++ b/docs/dendrite/README.md @@ -0,0 +1,19 @@ +# Dendrite configuration files + +This directory contains some Dendrite configuration files to be taken as examples. + +| File | Use | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------| +| `dendrite-sample.monolith.yaml` | Dendrite executed in the mode where all functionalities are implemented by a single process (*monolith*). | +| `dendrite-sample.polylith.yaml` | Dendrite executed in the mode where each main functionality is implemented by an independent process (*polylith*). | + +It is also possible to generate a generic configuration file from scratch using the command `generate-config`. + +* Linux or *nix-like OS + ```sh + bin/generate-config -server example.com -db postgres://user:password@dbhost:5432/dbname?sslmode=disable > dendrite.yaml + ``` +* Windows + ```dos + generate-config.exe -server example.com -db postgres://user:password@dbhost:5432/dbname?sslmode=disable > dendrite.yaml + ``` diff --git a/dendrite-sample.monolith.yaml b/docs/dendrite/dendrite-sample.monolith.yaml similarity index 100% rename from dendrite-sample.monolith.yaml rename to docs/dendrite/dendrite-sample.monolith.yaml diff --git a/dendrite-sample.polylith.yaml b/docs/dendrite/dendrite-sample.polylith.yaml similarity index 100% rename from dendrite-sample.polylith.yaml rename to docs/dendrite/dendrite-sample.polylith.yaml diff --git a/docs/installation/7_configuration.md b/docs/installation/7_configuration.md index e676afbe6..f3e4fc8bc 100644 --- a/docs/installation/7_configuration.md +++ b/docs/installation/7_configuration.md @@ -10,8 +10,8 @@ permalink: /installation/configuration The configuration file is used to configure Dendrite. Sample configuration files are present in the top level of the Dendrite repository: -* [`dendrite-sample.monolith.yaml`](https://github.com/matrix-org/dendrite/blob/main/dendrite-sample.monolith.yaml) -* [`dendrite-sample.polylith.yaml`](https://github.com/matrix-org/dendrite/blob/main/dendrite-sample.polylith.yaml) +* [`dendrite-sample.monolith.yaml`](https://github.com/matrix-org/dendrite/blob/main/docs/dendrite/dendrite-sample.monolith.yaml) +* [`dendrite-sample.polylith.yaml`](https://github.com/matrix-org/dendrite/blob/main/docs/dendrite/dendrite-sample.polylith.yaml) You will need to duplicate the sample, calling it `dendrite.yaml` for example, and then tailor it to your installation. At a minimum, you will need to populate the following