112 lines
4.3 KiB
Markdown
112 lines
4.3 KiB
Markdown
# Matrix (Synapse)
|
|
|
|
<!-- metadata -->
|
|
|
|
* **Category**: Apps
|
|
* **Status**: 0, work-in-progress
|
|
* **Image**: [`matrixdotorg/synapse`](https://hub.docker.com/r/matrixdotorg/synapse), 4, upstream
|
|
* **Healthcheck**: Yes
|
|
* **Backups**: No
|
|
* **Email**: Yes
|
|
* **Tests**: No
|
|
* **SSO**: Yes
|
|
|
|
<!-- endmetadata -->
|
|
|
|
## Basic usage
|
|
|
|
1. Set up Docker Swarm and [`abra`](https://docs.coopcloud.tech/abra/)
|
|
2. Deploy [`coop-cloud/traefik`](https://git.coopcloud.tech/coop-cloud/traefik)
|
|
3. `abra app new matrix-synapse --secrets` (optionally with `--pass` if you'd like to save secrets in `pass`)
|
|
4. `abra app config YOURAPPDOMAIN` - be sure to change `$DOMAIN` to something that resolves to your Docker swarm box
|
|
5. `abra app deploy YOURAPPDOMAIN`
|
|
6. Create an initial user: `abra app run YOURAPPDOMAIN app register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008`
|
|
|
|
## Tips & Tricks
|
|
|
|
### Disabling federation
|
|
|
|
- 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!
|
|
|
|
### 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.
|
|
|
|
### Telegram bridging
|
|
|
|
> WIP docs
|
|
|
|
Setting it up is a bit of a chicken/egg & chasing cats moment.
|
|
|
|
You need to get your bot setup on the telegram side first and have these values:
|
|
|
|
```
|
|
api_id: ...
|
|
api_hash: ...
|
|
telegram_bot_token: ...
|
|
```
|
|
|
|
Here is a rough guide:
|
|
|
|
```
|
|
abra app secret insert <domain> telegram_api_hash v1 <secret>
|
|
abra app secret insert <domain> telegram_bot_token v1 <secret>
|
|
abra app secret generate -a <domain>
|
|
|
|
abra app deploy <domain>
|
|
abra app run matrix.fva.wtf telegram_bridge cat /data/registration.yaml
|
|
abra app undeploy <domain>
|
|
|
|
abra app secret rm <domain> telegram_as_token
|
|
abra app secret insert <domain> telegram_as_token v1 <secret>
|
|
|
|
abra app secret rm <domain> telegram_as_token
|
|
abra app secret insert <domain> telegram_hs_token v1 <secret>
|
|
|
|
abra app deploy <domain>
|
|
```
|
|
|
|
Some helpful documentation:
|
|
|
|
- [`docs.mau.fi`](https://docs.mau.fi/bridges/python/setup/docker.html?bridge=telegram)
|
|
- [`example-config.yaml`](https://mau.dev/mautrix/telegram/-/blob/master/mautrix_telegram/example-config.yaml)
|
|
|
|
### Discord bridging
|
|
|
|
> WIP docs
|
|
|
|
Just as messy as the Telegram bridging above! Rough guide:
|
|
|
|
- get a local copy of [`config.yaml`](https://github.com/matrix-org/matrix-appservice-discord/blob/develop/config/config.sample.yaml)
|
|
- fill it out with the values you need, all the discord token stuff, etc.
|
|
- run `mkdir -p data && cp config.yaml data/` then `docker run --rm -v data:/data halfshot/matrix-appservice-discord:v1.0.0 sh -c "cd /data && node /build/src/discordas.js -r -u "http://discordbridge:9005" -c config.yaml"`
|
|
- this generates the app service registration configuration you need to feed to the homeserver
|
|
- run secret generation for the `discord_db_password`, insert your `discord_bot_token`
|
|
- run `abra app cp <domain> discord-registration.yaml app:/discord-data` (it has to be called `discord-registration.yaml`)
|
|
- deploy the bridge & happy hacking
|
|
|
|
Some helpful documentation:
|
|
|
|
- [`matrix-org/matrix-appservice-discord` docs](https://github.com/matrix-org/matrix-appservice-discord#bridging-a-room)
|
|
- [`t2bot.io/discord`](https://t2bot.io/discord/)
|
|
|
|
### Signal bridging
|
|
|
|
> WIP docs
|
|
|
|
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`
|
|
- `abra app secret insert example.com signal_as_token v1 foo`
|
|
- generate the database password:
|
|
- `abra app secret generate example.com -a`
|
|
- deploy the thing and then check the `/data/registration.yaml`
|
|
- rm the fake `signal_hs/as_token` values and re-insert the new ones from `registration.yaml`
|
|
- re-deploy the whole thing and then it should come up, message `@signalbot:example.com` to test
|