Compare commits
9 Commits
1.1.0+v1.5
...
1.2.0+v1.5
Author | SHA1 | Date | |
---|---|---|---|
1188f5d770 | |||
17ad6ac250
|
|||
1bcb2d83b2
|
|||
8ded1abe20
|
|||
6f3e135b1d
|
|||
02a9d526fd
|
|||
d5bde0c969
|
|||
29c4b53f40
|
|||
89bb7a9f58
|
10
.drone.yml
10
.drone.yml
@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
name: recipe release
|
|
||||||
steps:
|
|
||||||
- name: release a new version
|
|
||||||
image: thecoopcloud/drone-abra:latest
|
|
||||||
settings:
|
|
||||||
command: recipe matrix-synapse release
|
|
||||||
deploy_key:
|
|
||||||
from_secret: abra_bot_deploy_key
|
|
3
.gitignore
vendored
3
.gitignore
vendored
@ -1 +1,2 @@
|
|||||||
/.envrc
|
.envrc
|
||||||
|
synapse
|
||||||
|
51
README.md
51
README.md
@ -1,7 +1,5 @@
|
|||||||
# Matrix (Synapse)
|
# Matrix (Synapse)
|
||||||
|
|
||||||
[](https://drone.autonomic.zone/coop-cloud/matrix-synapse)
|
|
||||||
|
|
||||||
<!-- metadata -->
|
<!-- metadata -->
|
||||||
|
|
||||||
* **Category**: Apps
|
* **Category**: Apps
|
||||||
@ -9,30 +7,47 @@
|
|||||||
* **Image**: [`matrixdotorg/synapse`](https://hub.docker.com/r/matrixdotorg/synapse), 4, upstream
|
* **Image**: [`matrixdotorg/synapse`](https://hub.docker.com/r/matrixdotorg/synapse), 4, upstream
|
||||||
* **Healthcheck**: Yes
|
* **Healthcheck**: Yes
|
||||||
* **Backups**: No
|
* **Backups**: No
|
||||||
* **Email**: No
|
* **Email**: Yes
|
||||||
* **Tests**: No
|
* **Tests**: No
|
||||||
* **SSO**: No
|
* **SSO**: Yes
|
||||||
|
|
||||||
<!-- endmetadata -->
|
<!-- endmetadata -->
|
||||||
|
|
||||||
## Basic usage
|
## Basic usage
|
||||||
|
|
||||||
1. Set up Docker Swarm and [`abra`]
|
1. Set up Docker Swarm and [`abra`](https://docs.coopcloud.tech/abra/)
|
||||||
2. Deploy [`coop-cloud/traefik`]
|
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
|
3. `abra app new matrix-synapse --secrets` (optionally with `--pass` if you'd like to save secrets in `pass`)
|
||||||
to save secrets in `pass`)
|
4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to your Docker swarm box
|
||||||
4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
|
|
||||||
your Docker swarm box
|
|
||||||
5. `abra app YOURAPPDOMAIN deploy`
|
5. `abra app YOURAPPDOMAIN deploy`
|
||||||
6. Create an initial user:
|
6. Create an initial user: `abra app YOURAPPDOMAIN run app register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008`
|
||||||
`abra app YOURAPPDOMAIN run app register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008`
|
|
||||||
|
|
||||||
[abra]: https://git.autonomic.zone/autonomic-cooperative/abra
|
|
||||||
[cc-traefik]: https://git.autonomic.zone/coop-cloud/traefik
|
|
||||||
|
|
||||||
## Tips & Tricks
|
## Tips & Tricks
|
||||||
|
|
||||||
|
### Disabling federation
|
||||||
|
|
||||||
|
> We're not sure this does it exactly and there is still a discussion running
|
||||||
|
> upstrem 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
|
||||||
|
|
||||||
|
### 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`
|
### 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 \
|
docker run -it \
|
||||||
--entrypoint="" \
|
--entrypoint="" \
|
||||||
@ -52,3 +67,9 @@ docker run -it \
|
|||||||
matrixdotorg/synapse:v1.48.0 \
|
matrixdotorg/synapse:v1.48.0 \
|
||||||
sh -c '/start.py generate; cat /data/foo.com.log.config' > log.config
|
sh -c '/start.py generate; cat /data/foo.com.log.config' > log.config
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 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. Chang sets are welcome.
|
||||||
|
@ -3,7 +3,7 @@ version: "3.8"
|
|||||||
|
|
||||||
services:
|
services:
|
||||||
app:
|
app:
|
||||||
image: "matrixdotorg/synapse:v1.51.0"
|
image: "matrixdotorg/synapse:v1.52.0"
|
||||||
volumes:
|
volumes:
|
||||||
- "data:/data"
|
- "data:/data"
|
||||||
secrets:
|
secrets:
|
||||||
@ -51,7 +51,7 @@ services:
|
|||||||
- "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`)"
|
- "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`)"
|
||||||
- "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
|
- "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
|
||||||
- "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
|
- "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
|
||||||
- "coop-cloud.${STACK_NAME}.version=1.1.0+v1.51.0"
|
- "coop-cloud.${STACK_NAME}.version=1.2.0+v1.52.0"
|
||||||
|
|
||||||
db:
|
db:
|
||||||
image: postgres:13-alpine
|
image: postgres:13-alpine
|
||||||
|
Reference in New Issue
Block a user