mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2026-01-07 06:03:09 -06:00
Code Issues Packages Projects Releases Wiki Activity

mv sample config to docs/dendrite

Browse source
This commit is contained in:
emanuele.aliberti 2022-06-11 16:48:48 +02:00
parent 89d2adadbd
commit 6488956b5e
5 changed files with 24 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -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:

19
docs/dendrite/README.md Normal file
View file

@ -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
```

0
dendrite-sample.monolith.yaml → docs/dendrite/dendrite-sample.monolith.yaml
View file

0
dendrite-sample.polylith.yaml → docs/dendrite/dendrite-sample.polylith.yaml
View file

4
docs/installation/7_configuration.md
View file

@ -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