mirror of
https://github.com/1f349/dendrite.git
synced 2024-11-09 22:42:58 +00:00
Update documentation (#1569)
* Update dendrite-config.yaml * Update README.md * Update INSTALL.md * Update INSTALL.md
This commit is contained in:
parent
59428cdde3
commit
0af35bec1a
20
README.md
20
README.md
@ -54,22 +54,24 @@ The following instructions are enough to get Dendrite started as a non-federatin
|
|||||||
```bash
|
```bash
|
||||||
$ git clone https://github.com/matrix-org/dendrite
|
$ git clone https://github.com/matrix-org/dendrite
|
||||||
$ cd dendrite
|
$ cd dendrite
|
||||||
|
$ ./build.sh
|
||||||
|
|
||||||
# generate self-signed certificate and an event signing key for federation
|
# Generate a Matrix signing key for federation (required)
|
||||||
$ go build ./cmd/generate-keys
|
$ ./generate-keys --private-key matrix_key.pem
|
||||||
$ ./generate-keys --private-key matrix_key.pem --tls-cert server.crt --tls-key server.key
|
|
||||||
|
|
||||||
# Copy and modify the config file:
|
# Generate a self-signed certificate (optional, but a valid TLS certificate is normally
|
||||||
# you'll need to set a server name and paths to the keys at the very least, along with setting
|
# needed for Matrix federation/clients to work properly!)
|
||||||
# up the database filenames
|
$ ./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.
|
||||||
$ cp dendrite-config.yaml dendrite.yaml
|
$ cp dendrite-config.yaml dendrite.yaml
|
||||||
|
|
||||||
# build and run the server
|
# Build and run the server:
|
||||||
$ go build ./cmd/dendrite-monolith-server
|
|
||||||
$ ./dendrite-monolith-server --tls-cert server.crt --tls-key server.key --config dendrite.yaml
|
$ ./dendrite-monolith-server --tls-cert server.crt --tls-key server.key --config dendrite.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
Then point your favourite Matrix client at `http://localhost:8008`.
|
Then point your favourite Matrix client at `http://localhost:8008` or `https://localhost:8448`.
|
||||||
|
|
||||||
## Progress
|
## Progress
|
||||||
|
|
||||||
|
@ -36,6 +36,8 @@ global:
|
|||||||
server_name: localhost
|
server_name: localhost
|
||||||
|
|
||||||
# The path to the signing private key file, used to sign requests and events.
|
# The path to the signing private key file, used to sign requests and events.
|
||||||
|
# Note that this is NOT the same private key as used for TLS! To generate a
|
||||||
|
# signing key, use "./bin/generate-keys --private-key matrix_key.pem".
|
||||||
private_key: matrix_key.pem
|
private_key: matrix_key.pem
|
||||||
|
|
||||||
# The paths and expiry timestamps (as a UNIX timestamp in millisecond precision)
|
# The paths and expiry timestamps (as a UNIX timestamp in millisecond precision)
|
||||||
|
@ -12,6 +12,8 @@ Dendrite can be run in one of two configurations:
|
|||||||
lightweight implementation called [Naffka](https://github.com/matrix-org/naffka). This
|
lightweight implementation called [Naffka](https://github.com/matrix-org/naffka). This
|
||||||
will usually be the preferred model for low-volume, low-user or experimental deployments.
|
will usually be the preferred model for low-volume, low-user or experimental deployments.
|
||||||
|
|
||||||
|
For most deployments, it is **recommended to run in monolith mode with PostgreSQL databases**.
|
||||||
|
|
||||||
Regardless of whether you are running in polylith or monolith mode, each Dendrite component that
|
Regardless of whether you are running in polylith or monolith mode, each Dendrite component that
|
||||||
requires storage has its own database. Both Postgres and SQLite are supported and can be
|
requires storage has its own database. Both Postgres and SQLite are supported and can be
|
||||||
mixed-and-matched across components as needed in the configuration file.
|
mixed-and-matched across components as needed in the configuration file.
|
||||||
@ -30,23 +32,9 @@ If you want to run a polylith deployment, you also need:
|
|||||||
|
|
||||||
* Apache Kafka 0.10.2+
|
* Apache Kafka 0.10.2+
|
||||||
|
|
||||||
## Building up a monolith deploment
|
Please note that Kafka is **not required** for a monolith deployment.
|
||||||
|
|
||||||
Start by cloning the code:
|
## Building Dendrite
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/matrix-org/dendrite
|
|
||||||
cd dendrite
|
|
||||||
```
|
|
||||||
|
|
||||||
Then build it:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go build -o bin/dendrite-monolith-server ./cmd/dendrite-monolith-server
|
|
||||||
go build -o bin/generate-keys ./cmd/generate-keys
|
|
||||||
```
|
|
||||||
|
|
||||||
## Building up a polylith deployment
|
|
||||||
|
|
||||||
Start by cloning the code:
|
Start by cloning the code:
|
||||||
|
|
||||||
@ -61,6 +49,8 @@ Then build it:
|
|||||||
./build.sh
|
./build.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Install Kafka (polylith only)
|
||||||
|
|
||||||
Install and start Kafka (c.f. [scripts/install-local-kafka.sh](scripts/install-local-kafka.sh)):
|
Install and start Kafka (c.f. [scripts/install-local-kafka.sh](scripts/install-local-kafka.sh)):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@ -96,9 +86,9 @@ Dendrite can use the built-in SQLite database engine for small setups.
|
|||||||
The SQLite databases do not need to be pre-built - Dendrite will
|
The SQLite databases do not need to be pre-built - Dendrite will
|
||||||
create them automatically at startup.
|
create them automatically at startup.
|
||||||
|
|
||||||
### Postgres database setup
|
### PostgreSQL database setup
|
||||||
|
|
||||||
Assuming that Postgres 9.6 (or later) is installed:
|
Assuming that PostgreSQL 9.6 (or later) is installed:
|
||||||
|
|
||||||
* Create role, choosing a new password when prompted:
|
* Create role, choosing a new password when prompted:
|
||||||
|
|
||||||
@ -118,18 +108,28 @@ Assuming that Postgres 9.6 (or later) is installed:
|
|||||||
|
|
||||||
### Server key generation
|
### Server key generation
|
||||||
|
|
||||||
Each Dendrite server requires unique server keys.
|
Each Dendrite installation requires:
|
||||||
|
|
||||||
In order for an instance to federate correctly, you should have a valid
|
- A unique Matrix signing private key
|
||||||
certificate issued by a trusted authority, and private key to match. If you
|
- A valid and trusted TLS certificate and private key
|
||||||
don't and just want to test locally, generate the self-signed SSL certificate
|
|
||||||
for federation and the server signing key:
|
To generate a Matrix signing private key:
|
||||||
|
|
||||||
```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
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have server keys from an older synapse instance,
|
**Warning:** Make sure take a safe backup of this key! You will likely need it if you want to reinstall Dendrite, or
|
||||||
|
any other Matrix homeserver, on the same domain name in the future. If you lose this key, you may have trouble joining
|
||||||
|
federated rooms.
|
||||||
|
|
||||||
|
For testing, you can generate a self-signed certificate and key, although this will not work for public federation:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./bin/generate-keys --tls-cert server.crt --tls-key server.key
|
||||||
|
```
|
||||||
|
|
||||||
|
If you have server keys from an older Synapse instance,
|
||||||
[convert them](serverkeyformat.md#converting-synapse-keys) to Dendrite's PEM
|
[convert them](serverkeyformat.md#converting-synapse-keys) to Dendrite's PEM
|
||||||
format and configure them as `old_private_keys` in your config.
|
format and configure them as `old_private_keys` in your config.
|
||||||
|
|
||||||
@ -140,9 +140,9 @@ Create config file, based on `dendrite-config.yaml`. Call it `dendrite.yaml`. Th
|
|||||||
* The `server_name` entry to reflect the hostname of your Dendrite server
|
* The `server_name` entry to reflect the hostname of your Dendrite server
|
||||||
* The `database` lines with an updated connection string based on your
|
* The `database` lines with an updated connection string based on your
|
||||||
desired setup, e.g. replacing `database` with the name of the database:
|
desired setup, e.g. replacing `database` with the name of the database:
|
||||||
* For Postgres: `postgres://dendrite:password@localhost/database`
|
* For Postgres: `postgres://dendrite:password@localhost/database`, e.g. `postgres://dendrite:password@localhost/dendrite_userapi_account.db`
|
||||||
* For SQLite on disk: `file:component.db` or `file:///path/to/component.db`
|
* For SQLite on disk: `file:component.db` or `file:///path/to/component.db`, e.g. `file:userapi_account.db`
|
||||||
* Postgres and SQLite can be mixed and matched.
|
* Postgres and SQLite can be mixed and matched on different components as desired.
|
||||||
* The `use_naffka` option if using Naffka in a monolith deployment
|
* The `use_naffka` option if using Naffka in a monolith deployment
|
||||||
|
|
||||||
There are other options which may be useful so review them all. In particular,
|
There are other options which may be useful so review them all. In particular,
|
||||||
@ -152,7 +152,7 @@ help to improve reliability considerably by allowing your homeserver to fetch
|
|||||||
public keys for dead homeservers from somewhere else.
|
public keys for dead homeservers from somewhere else.
|
||||||
|
|
||||||
**WARNING:** Dendrite supports running all components from the same database in
|
**WARNING:** Dendrite supports running all components from the same database in
|
||||||
Postgres mode, but this is **NOT** a supported configuration with SQLite. When
|
PostgreSQL mode, but this is **NOT** a supported configuration with SQLite. When
|
||||||
using SQLite, all components **MUST** use their own database file.
|
using SQLite, all components **MUST** use their own database file.
|
||||||
|
|
||||||
## Starting a monolith server
|
## Starting a monolith server
|
||||||
@ -164,8 +164,14 @@ 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://servername:8008` as the server:
|
||||||
as shown below, it will also listen for HTTPS connections on port 8448.
|
|
||||||
|
```bash
|
||||||
|
./bin/dendrite-monolith-server
|
||||||
|
```
|
||||||
|
|
||||||
|
If you set `--tls-cert` and `--tls-key` as shown below, it will also listen
|
||||||
|
for HTTPS connections on port 8448:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./bin/dendrite-monolith-server --tls-cert=server.crt --tls-key=server.key
|
./bin/dendrite-monolith-server --tls-cert=server.crt --tls-key=server.key
|
||||||
|
Loading…
Reference in New Issue
Block a user