docs: README pass

This commit is contained in:
decentral1se 2023-01-08 02:09:55 +01:00
parent 89f5069aa2
commit 4445e0249f
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
1 changed files with 8 additions and 53 deletions

View File

@ -26,65 +26,20 @@
### Disabling federation ### Disabling federation
> We're not sure this does it exactly and there is still a discussion running - Use `DISABLE_FEDERATION=1` to turn off federation listeners
> upstream about whether this is the right way to do it & whether it could be - Don't use [`compose.matrix.yml`](https://git.coopcloud.tech/coop-cloud/traefik/src/branch/master/compose.matrix.yml) in your traefik config to keep the federation ports closed
> more convenient. We welcome issues / change sets to close up more federation
> functionality.
- use `DISABLE_FEDERATION=1` to turn off federation listeners
- don't use [`compose.matrix.yml`](https://git.coopcloud.tech/coop-cloud/traefik/src/branch/master/compose.matrix.yml) in your traefik config to keep the federation ports closed
### Enabling federation ### Enabling federation
See [`#27`](https://git.coopcloud.tech/coop-cloud/matrix-synapse/pulls/27) for more. See [`#27`](https://git.coopcloud.tech/coop-cloud/matrix-synapse/pulls/27) for more. Depending on your setup, using `SERVE_SERVER_WELLKNOWN=true` might work to start federating. Make sure you don't leave `DISABLE_FEDERATION=1` set!
Depending on your setup, using `SERVE_SERVER_WELLKNOWN=true` might work to start federating.
Make sure you don't leave `DISABLE_FEDERATION=1` set!
### Seeing what changed in `homeserver.yaml` between versions
Change the version range to suit your needs.
```
git clone https://github.com/matrix-org/synapse
cd synapse/docs
git log --follow -p v1.48.0..v1.51.0 sample_config.yaml
```
### Generating a new `homeserver.yaml`
The default is also available to see [here](https://matrix-org.github.io/synapse/latest/usage/configuration/homeserver_sample_config.html).
```
docker run -it \
--entrypoint="" \
-e SYNAPSE_SERVER_NAME=foo.com \
-e SYNAPSE_REPORT_STATS=no \
matrixdotorg/synapse:v1.48.0 \
sh -c '/start.py generate; cat /data/homeserver.yaml' > homeserver.yaml.tmpl`
```
### Generating a new `<server>.log.config`
```
docker run -it \
--entrypoint="" \
-e SYNAPSE_SERVER_NAME=foo.com \
-e SYNAPSE_REPORT_STATS=no \
matrixdotorg/synapse:v1.48.0 \
sh -c '/start.py generate; cat /data/foo.com.log.config' > log.config
```
### Getting client discovery on a custom domain ### Getting client discovery on a custom domain
You'll need to deploy something like [this](https://git.autonomic.zone/ruangrupa/well-known-uris). You'll need to deploy something like [this](https://git.autonomic.zone/ruangrupa/well-known-uris). This could be implemented in this recipe but we haven't merged it in yet. Change sets are welcome.
This could be implemented in this recipe but we haven't merged it in yet. Change sets are welcome.
### Telegram bridging ### Telegram bridging
> WIP > WIP docs
Setting it up is a bit of a chicken/egg & chasing cats moment. Setting it up is a bit of a chicken/egg & chasing cats moment.
@ -123,7 +78,7 @@ Some helpful documentation:
### Discord bridging ### Discord bridging
> WIP > WIP docs
Just as messy as the Telegram bridging above! Rough guide: Just as messy as the Telegram bridging above! Rough guide:
@ -142,9 +97,9 @@ Some helpful documentation:
### Signal bridging ### Signal bridging
> WIP > WIP docs
OK, it's also awful to set this up. Do you see a pattern emerging? :) OK, it's also awful to set this up. Do you see a pattern emerging :)
- fake that you have the required tokens: - fake that you have the required tokens:
- `abra app secret insert example.com signal_hs_token v1 foo` - `abra app secret insert example.com signal_hs_token v1 foo`