mirror of
https://github.com/matrix-org/dendrite.git
synced 2026-01-09 07:03:10 -06:00
Starting pages
This commit is contained in:
parent
8fb3c45b0c
commit
1d5887d505
|
|
@ -97,6 +97,13 @@ enabled.
|
||||||
To do so, follow the [NATS Server installation instructions](https://docs.nats.io/running-a-nats-service/introduction/installation) and then [start your NATS deployment](https://docs.nats.io/running-a-nats-service/introduction/running). JetStream must be enabled, either by passing the `-js` flag to `nats-server`,
|
To do so, follow the [NATS Server installation instructions](https://docs.nats.io/running-a-nats-service/introduction/installation) and then [start your NATS deployment](https://docs.nats.io/running-a-nats-service/introduction/running). JetStream must be enabled, either by passing the `-js` flag to `nats-server`,
|
||||||
or by specifying the `store_dir` option in the the `jetstream` configuration.
|
or by specifying the `store_dir` option in the the `jetstream` configuration.
|
||||||
|
|
||||||
|
### Reverse proxy (polylith deployments)
|
||||||
|
|
||||||
|
Polylith deployments require a reverse proxy, such as [NGINX](https://www.nginx.com) or
|
||||||
|
[HAProxy](http://www.haproxy.org). Configuring those is not covered in this documentation,
|
||||||
|
although a [sample configuration for NGINX](https://github.com/matrix-org/dendrite/blob/main/docs/nginx/polylith-sample.conf)
|
||||||
|
is provided.
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
|
|
||||||
Finally, if you want to build Dendrite on Windows, you will need need `gcc` in the path. The best
|
Finally, if you want to build Dendrite on Windows, you will need need `gcc` in the path. The best
|
||||||
|
|
|
||||||
|
|
@ -22,3 +22,12 @@ go build -o /usr/local/bin/ ./cmd/dendrite-polylith-multi
|
||||||
|
|
||||||
The `dendrite-polylith-multi` binary is a "multi-personality" binary which can run as
|
The `dendrite-polylith-multi` binary is a "multi-personality" binary which can run as
|
||||||
any of the components depending on the supplied command line parameters.
|
any of the components depending on the supplied command line parameters.
|
||||||
|
|
||||||
|
## Reverse proxy
|
||||||
|
|
||||||
|
Polylith deployments require a reverse proxy in order to ensure that requests are
|
||||||
|
sent to the correct endpoint. You must ensure that a suitable reverse proxy is installed
|
||||||
|
and configured.
|
||||||
|
|
||||||
|
A [sample configuration file](https://github.com/matrix-org/dendrite/blob/main/docs/nginx/polylith-sample.conf)
|
||||||
|
is provided for [NGINX](https://www.nginx.com).
|
||||||
|
|
|
||||||
41
docs/installation/8_starting_monolith.md
Normal file
41
docs/installation/8_starting_monolith.md
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
---
|
||||||
|
title: Starting the monolith
|
||||||
|
parent: Installation
|
||||||
|
has_toc: true
|
||||||
|
nav_order: 9
|
||||||
|
permalink: /installation/start/monolith
|
||||||
|
---
|
||||||
|
|
||||||
|
# Starting the monolith
|
||||||
|
|
||||||
|
Once you have completed all of the preparation and installation steps,
|
||||||
|
you can start your Dendrite monolith deployment by starting the `dendrite-monolith-server`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-monolith-server -config /path/to/dendrite.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
If you want to change the addresses or ports that Dendrite listens on, you
|
||||||
|
can use the `-http-bind-address` and `-https-bind-address` command line arguments:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-monolith-server -config /path/to/dendrite.yaml \
|
||||||
|
-http-bind-address 1.2.3.4:12345 \
|
||||||
|
-https-bind-address 1.2.3.4:54321
|
||||||
|
```
|
||||||
|
|
||||||
|
## Running under systemd
|
||||||
|
|
||||||
|
A common deployment pattern is to run the monolith under systemd. For this, you
|
||||||
|
will need to create a service unit file. An example service unit file is available
|
||||||
|
in the [GitHub repository](https://github.com/matrix-org/dendrite/blob/main/docs/systemd/monolith-example.service).
|
||||||
|
|
||||||
|
Once you have installed the service unit, you can notify systemd, enable and start
|
||||||
|
the service:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
systemctl daemon-reload
|
||||||
|
systemctl enable dendrite
|
||||||
|
systemctl start dendrite
|
||||||
|
journalctl -fu dendrite
|
||||||
|
```
|
||||||
73
docs/installation/9_starting_polylith.md
Normal file
73
docs/installation/9_starting_polylith.md
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
---
|
||||||
|
title: Starting the polylith
|
||||||
|
parent: Installation
|
||||||
|
has_toc: true
|
||||||
|
nav_order: 9
|
||||||
|
permalink: /installation/start/polylith
|
||||||
|
---
|
||||||
|
|
||||||
|
# Starting the polylith
|
||||||
|
|
||||||
|
Once you have completed all of the preparation and installation steps,
|
||||||
|
you can start your Dendrite polylith deployment by starting the various components
|
||||||
|
using the `dendrite-polylith-multi` personalities.
|
||||||
|
|
||||||
|
## Start the reverse proxy
|
||||||
|
|
||||||
|
Ensure that your reverse proxy is started and is proxying the correct
|
||||||
|
endpoints to the correct components. Software such as [NGINX](https://www.nginx.com) or
|
||||||
|
[HAProxy](http://www.haproxy.org) can be used for this purpose. A [sample configuration
|
||||||
|
for NGINX](https://github.com/matrix-org/dendrite/blob/main/docs/nginx/polylith-sample.conf)
|
||||||
|
is provided.
|
||||||
|
|
||||||
|
## Starting the components
|
||||||
|
|
||||||
|
Each component must be started individually:
|
||||||
|
|
||||||
|
### Client API
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-polylith-multi -config /path/to/dendrite.yaml clientapi
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sync API
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-polylith-multi -config /path/to/dendrite.yaml syncapi
|
||||||
|
```
|
||||||
|
|
||||||
|
### Media API
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-polylith-multi -config /path/to/dendrite.yaml mediaapi
|
||||||
|
```
|
||||||
|
|
||||||
|
### Federation API
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-polylith-multi -config /path/to/dendrite.yaml federationapi
|
||||||
|
```
|
||||||
|
|
||||||
|
### Roomserver
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-polylith-multi -config /path/to/dendrite.yaml roomserver
|
||||||
|
```
|
||||||
|
|
||||||
|
### Appservice API
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-polylith-multi -config /path/to/dendrite.yaml appservice
|
||||||
|
```
|
||||||
|
|
||||||
|
### User API
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-polylith-multi -config /path/to/dendrite.yaml userapi
|
||||||
|
```
|
||||||
|
|
||||||
|
### Key server
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./dendrite-polylith-multi -config /path/to/dendrite.yaml keyserver
|
||||||
|
```
|
||||||
Loading…
Reference in a new issue