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

specifies the installation of the private key on Windows

Browse source
This commit is contained in:
Emanuele Aliberti 2022-05-09 12:32:03 +02:00
parent 315255b6b5
commit bd88b8880b
1 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/INSTALL.md
View file

@ -27,16 +27,16 @@ be mixed-and-matched across components as needed in the configuration file.
## Requirements ## Requirements
* Monolith Dendrite requires: * **Monolith Dendrite** requires:
* if using PostgreSQL database(s) * if using **PostgreSQL** database(s)
* PostgreSQL 12 or higher * PostgreSQL 12 or higher
* if using SQLite databases * if using **SQLite** databases
* ... * ...
* Polylith Dendrite requires: * **Polylith Dendrite** requires:
* if using PostgreSQL database(s) * if using **PostgreSQL** database(s)
* PostgreSQL 12 or higher * PostgreSQL 12 or higher
* A standalone [NATS Server](https://github.com/nats-io/nats-server) deployment with JetStream enabled * A standalone [NATS Server](https://github.com/nats-io/nats-server) deployment with JetStream enabled
* if using SQLite databases * if using **SQLite** databases
* A standalone [NATS Server](https://github.com/nats-io/nats-server) deployment with JetStream enabled * A standalone [NATS Server](https://github.com/nats-io/nats-server) deployment with JetStream enabled
## Install NATS Server ## Install NATS Server
@ -44,8 +44,9 @@ be mixed-and-matched across components as needed in the configuration file.
> An independent NATS server is *only **required** for installation of > An independent NATS server is *only **required** for installation of
> Dentrite in polylith mode*. Dendrite in monolith mode uses, by > Dentrite in polylith mode*. Dendrite in monolith mode uses, by
> default, an in-process NATS server, but there is no reason > default, an in-process NATS server, but there is no reason
> why an external one should not be used, if for example it is already > why an external one should not be used, if for example if NATS is
> available on the machine where Dendrite will be installed. > already installed on a machine that is visible and accessible from
> the machine where Dendrite will be installed.
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). 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).
@ -107,10 +108,18 @@ Each Dendrite installation requires:
To generate a Matrix signing private key: To generate a Matrix signing private key:
* On Linux, or UNIX-like systems
```bash ```bash
./bin/generate-keys --private-key matrix_key.pem ./bin/generate-keys --private-key matrix_key.pem
``` ```
* On Windows
```dos
bin\generate-keys.exe --private-key C:\ProgramData\Dendrite\matrix_key.pem
```
**WARNING:** Make sure take a safe backup of this key! You will likely need it if you want to reinstall Dendrite, or **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 any other Matrix homeserver, on the same domain name in the future. If you lose this key, you may have trouble joining
federated rooms. federated rooms.