Update README.md

This commit is contained in:
Neil Alexander 2020-10-26 21:54:15 +00:00 committed by GitHub
parent c009186cb4
commit c48394dd25
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

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