mirror of
https://github.com/1f349/dendrite.git
synced 2024-11-09 22:42:58 +00:00
Propose config better (#1758)
Better explain where the config file are located and how to deal with the yml file. Co-authored-by: kegsay <kegan@matrix.org>
This commit is contained in:
parent
acec6fa979
commit
e48a08fef0
@ -28,8 +28,8 @@ There are three sample `docker-compose` files:
|
|||||||
The `docker-compose` files refer to the `/etc/dendrite` volume as where the
|
The `docker-compose` files refer to the `/etc/dendrite` volume as where the
|
||||||
runtime config should come from. The mounted folder must contain:
|
runtime config should come from. The mounted folder must contain:
|
||||||
|
|
||||||
- `dendrite.yaml` configuration file (based on the sample `dendrite-config.yaml`
|
- `dendrite.yaml` configuration file (based on the [`dendrite-config.yaml`](https://raw.githubusercontent.com/matrix-org/dendrite/master/dendrite-config.yaml)
|
||||||
in the `docker/config` folder in the [Dendrite repository](https://github.com/matrix-org/dendrite)
|
sample in the `build/docker/config` folder of this repository.)
|
||||||
- `matrix_key.pem` server key, as generated using `cmd/generate-keys`
|
- `matrix_key.pem` server key, as generated using `cmd/generate-keys`
|
||||||
- `server.crt` certificate file
|
- `server.crt` certificate file
|
||||||
- `server.key` private key file for the above certificate
|
- `server.key` private key file for the above certificate
|
||||||
@ -50,8 +50,7 @@ The key files will now exist in your current working directory, and can be mount
|
|||||||
|
|
||||||
## Starting Dendrite as a monolith deployment
|
## Starting Dendrite as a monolith deployment
|
||||||
|
|
||||||
Create your config based on the `dendrite.yaml` configuration file in the `docker/config`
|
Create your config based on the [`dendrite-config.yaml`](https://raw.githubusercontent.com/matrix-org/dendrite/master/dendrite-config.yaml) configuration file in the `build/docker/config` folder of this repository. And rename the config file to `dendrite.yml` (and put it in your `config` directory).
|
||||||
folder in the [Dendrite repository](https://github.com/matrix-org/dendrite).
|
|
||||||
|
|
||||||
Once in place, start the PostgreSQL dependency:
|
Once in place, start the PostgreSQL dependency:
|
||||||
|
|
||||||
@ -67,8 +66,7 @@ docker-compose -f docker-compose.monolith.yml up
|
|||||||
|
|
||||||
## Starting Dendrite as a polylith deployment
|
## Starting Dendrite as a polylith deployment
|
||||||
|
|
||||||
Create your config based on the `dendrite.yaml` configuration file in the `docker/config`
|
Create your config based on the [`dendrite-config.yaml`](https://raw.githubusercontent.com/matrix-org/dendrite/master/dendrite-config.yaml) configuration file in the `build/docker/config` folder of this repository. And rename the config file to `dendrite.yml` (and put it in your `config` directory).
|
||||||
folder in the [Dendrite repository](https://github.com/matrix-org/dendrite).
|
|
||||||
|
|
||||||
Once in place, start all the dependencies:
|
Once in place, start all the dependencies:
|
||||||
|
|
||||||
@ -84,10 +82,10 @@ docker-compose -f docker-compose.polylith.yml up
|
|||||||
|
|
||||||
## Building the images
|
## Building the images
|
||||||
|
|
||||||
The `docker/images-build.sh` script will build the base image, followed by
|
The `build/docker/images-build.sh` script will build the base image, followed by
|
||||||
all of the component images.
|
all of the component images.
|
||||||
|
|
||||||
The `docker/images-push.sh` script will push them to Docker Hub (subject
|
The `build/docker/images-push.sh` script will push them to Docker Hub (subject
|
||||||
to permissions).
|
to permissions).
|
||||||
|
|
||||||
If you wish to build and push your own images, rename `matrixdotorg/dendrite` to
|
If you wish to build and push your own images, rename `matrixdotorg/dendrite` to
|
||||||
|
Loading…
Reference in New Issue
Block a user