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

Merge remote-tracking branch 'origin/dymattic-install' into dymattic-install

Browse source
This commit is contained in:
Dmitrij Pastian 2020-10-20 17:59:44 +02:00
parent 8d3ad7fec7 829263bfb9
commit cca4fdb86f
1 changed files with 38 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
docs/INSTALL.md
View file

@ -30,6 +30,9 @@ If you want to run a polylith deployment, you also need:
* Apache Kafka 0.10.2+ * Apache Kafka 0.10.2+
Depending on your environment additional packages might be required for building to succeed.
On Debian 10 install "build-essential" to be on the safe side: `apt install build-essential`
## Building up a monolith deploment ## Building up a monolith deploment
Start by cloning the code: Start by cloning the code:
@ -123,8 +126,17 @@ Each Dendrite server requires unique server keys.
In order for an instance to federate correctly, you should have a valid In order for an instance to federate correctly, you should have a valid
certificate issued by a trusted authority, and private key to match. If you certificate issued by a trusted authority, and private key to match. If you
don't and just want to test locally, generate the self-signed SSL certificate don't and just want to test locally, generate the self-signed SSL certificate
for federation and the server signing key: for federation and the server signing key.
`./bin/generate-keys` is used to generate keys and certificates.
In order to just generate the Matrix private key use this:
```bash
./bin/generate-keys --private-key matrix_key.pem
```
If you also need self-signed TLS-certificates use the following command:
```bash ```bash
./bin/generate-keys --private-key matrix_key.pem --tls-cert server.crt --tls-key server.key ./bin/generate-keys --private-key matrix_key.pem --tls-cert server.crt --tls-key server.key
``` ```
@ -158,7 +170,7 @@ the monolith server. To do this, set `use_naffka: true` in your `dendrite.yaml`
configuration and uncomment the relevant Naffka line in the `database` section. configuration and uncomment the relevant Naffka line in the `database` section.
Be sure to update the database username and password if needed. Be sure to update the database username and password if needed.
The monolith server can be started as shown below. By default it listens for The monolith server can be started as shown below. By default, it listens for
HTTP connections on port 8008, so you can configure your Matrix client to use HTTP connections on port 8008, so you can configure your Matrix client to use
`http://localhost:8008` as the server. If you set `--tls-cert` and `--tls-key` `http://localhost:8008` as the server. If you set `--tls-cert` and `--tls-key`
as shown below, it will also listen for HTTPS connections on port 8448. as shown below, it will also listen for HTTPS connections on port 8448.
@ -286,3 +298,27 @@ amongst other things.
./bin/dendrite-polylith-multi --config=dendrite.yaml userapi ./bin/dendrite-polylith-multi --config=dendrite.yaml userapi
``` ```
### Set up Systemd Services _(polylith)_
In order to run the whole polylith deployment daemonized with Systemd
the following script can set them up for you **(root-privileges required)**:
```bash
# ./install-polylith-systemd-units.sh
```
Example:
```bash
# ./install-polylith-systemd-units.sh -u dendrite -d /home/dendrite/server/ all
```
* user: dendrite
* path: /home/dendrite/server/
* selection: all
In order to start all installed services the wrapper "polyDendrite.service" can be used:
```bash
# systemctl start polyDendrite.service
```
Monitor with