diff --git a/README.md b/README.md index 40323fc..b2a08fd 100644 --- a/README.md +++ b/README.md @@ -26,65 +26,20 @@ ### Disabling federation -> We're not sure this does it exactly and there is still a discussion running -> upstream about whether this is the right way to do it & whether it could be -> 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 +- 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 -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! - -### 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 `.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 -``` +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! ### Getting client discovery on a custom domain -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. +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. ### Telegram bridging -> WIP +> WIP docs Setting it up is a bit of a chicken/egg & chasing cats moment. @@ -123,7 +78,7 @@ Some helpful documentation: ### Discord bridging -> WIP +> WIP docs Just as messy as the Telegram bridging above! Rough guide: @@ -142,9 +97,9 @@ Some helpful documentation: ### 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: - `abra app secret insert example.com signal_hs_token v1 foo`