Update README.md

Signed-off-by: Tommy <contact@tommytran.io>
This commit is contained in:
Tommy 2022-11-25 09:26:05 -05:00 committed by GitHub
parent dd11f6d8f9
commit 07cbbb1a6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,8 +2,9 @@
Matrix Synapse Docker-Compose
1. Update `docker-compose.yml`
2. Run `docker-compose run --rm -e SYNAPSE_SERVER_NAME=yourdomain.tld -e SYNAPSE_REPORT_STATS=no synapse generate`
3. Update ./files/homeserver.yaml
2. Update the hostname in `swag/nginx/proxy-confs/synapse.subdomain.conf` and `swag/nginx/proxy-confs/element.subdomain.conf`approprieately.
3. Run `docker-compose run --rm -e SYNAPSE_SERVER_NAME=yourdomain.tld -e SYNAPSE_REPORT_STATS=no synapse generate`
4. Update ./files/homeserver.yaml
- Update web_client_location to app.yourdomain.tld (Remember to remove the comment #)
- Update public_baseurl to matrix.yourdomain.tld (Remember to remove the comment #)
- Uncomment serve_server_wellknown to enable it and configure https://yourdoman.tld/.well-known/matrix/server for federation
@ -13,10 +14,10 @@ Matrix Synapse Docker-Compose
- Configure `admin_contact` in the homeserver blocking section
- Enable `encryption_enabled_by_default_for_room_type` by default
- Edit whatever else you might want to
4. Copy config.sample.json from https://github.com/vector-im/element-web to `./element/config.json` and make the approriate adjustments
5. Tighten the Content Security Policy in `swag/nginx/ssl.conf` to suit your needs
5. Copy the config from https://github.com/matrix-org/pantalaimon to `./pantalaimon/pantalaimon.conf` and edit it accordingly
6. Run `docker-compose up` and make sure nothing errors out. You can use `docker-compose up -d` to start it in the background if you want.
7. Uncomment the security options for postgres. Run `docker-compose up -d` again.
8. Create a user for mjolnir
9. Copy the config from https://github.com/matrix-org/mjolnir/blob/main/config/default.yaml to `./mjolnir/config/production.yaml` and edit it accordingly. If you want Mjolnir to recieve reports instead of Synapse, make it listen on `0.0.0.0:8081`. You will also need to uncomment the approprieate lines in `./swag/nginx/proxy-confs/synapse.subdomain.conf` as well.
5. Copy config.sample.json from https://github.com/vector-im/element-web to `./element/config.json` and make the approriate adjustments
6. Tighten the Content Security Policy in `swag/nginx/ssl.conf` to suit your needs
7. Copy the config from https://github.com/matrix-org/pantalaimon to `./pantalaimon/pantalaimon.conf` and edit it accordingly
8. Run `docker-compose up` and make sure nothing errors out. You can use `docker-compose up -d` to start it in the background if you want.
9. Uncomment the security options for postgres. Run `docker-compose up -d` again.
10. Create a user for mjolnir
11. Copy the config from https://github.com/matrix-org/mjolnir/blob/main/config/default.yaml to `./mjolnir/config/production.yaml` and edit it accordingly. If you want Mjolnir to recieve reports instead of Synapse, make it listen on `0.0.0.0:8081`. You will also need to uncomment the approprieate lines in `./swag/nginx/proxy-confs/synapse.subdomain.conf` as well.