parent
e66832b78a
commit
bc7d4c3c92
37
README.md
37
README.md
|
@ -1,18 +1,27 @@
|
||||||
# Matrix Synapse
|
# Matrix (Synapse)
|
||||||
|
|
||||||
Matrix Synapse, based on the [official `matrixdotorg/synapse`
|
<!-- metadata -->
|
||||||
image][synapse-docker].
|
* **Category**: Apps
|
||||||
|
* **Status**: ❹💣
|
||||||
|
* **Image**: [`matrixdotorg/synapse`](https://hub.docker.com/r/matrixdotorg/synapse), ❶💚, upstream
|
||||||
|
* **Healthcheck**: Yes
|
||||||
|
* **Backups**: No
|
||||||
|
* **Email**: No
|
||||||
|
* **Tests**: ❷💛
|
||||||
|
* **SSO**: No
|
||||||
|
<!-- endmetadata -->
|
||||||
|
|
||||||
1. Set up Docker Swarm and [`abra`][abra]
|
## Basic usage
|
||||||
2. Deploy [`compose-stacks/traefik`][compose-traefik]
|
|
||||||
2. `cp .envrc.sample .envrc`
|
1. Set up Docker Swarm and [`abra`]
|
||||||
3. Edit `.envrc` - be sure to change `$DOMAIN` to something that resolves to
|
2. Deploy [`compose-stacks/traefik`]
|
||||||
|
3. `abra app new adaptauthoring --secrets` (optionally with `--pass` if you'd like
|
||||||
|
to save secrets in `pass`)
|
||||||
|
4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
|
||||||
your Docker swarm box
|
your Docker swarm box
|
||||||
4. `direnv allow` (or `. .envrc`)
|
5. `abra app YOURAPPDOMAIN deploy`
|
||||||
5. `abra deploy`
|
6. Create an initial user:
|
||||||
6. `abra service_run synapse` to open a shell
|
`abra app YOURAPPDOMAIN run app register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008`
|
||||||
7. `register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008`
|
|
||||||
|
|
||||||
[synapse-docker]: https://hub.docker.com/r/matrixdotorg/synapse
|
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
|
||||||
[abra]: https://git.autonomic.zone/autonomic-cooperative/abra
|
[`compose-stacks/traefik`]: https://git.autonomic.zone/compose-stacks/traefik
|
||||||
[compose-traefik]: https://git.autonomic.zone/compose-stacks/traefik
|
|
||||||
|
|
Loading…
Reference in New Issue