This repository has been archived on 2021-07-22. You can view files and clone it, but cannot push or open issues or pull requests.
rocketchat/README.md

49 lines
1.7 KiB
Markdown
Raw Normal View History

2020-09-24 18:56:27 +00:00
# Rocketchat
2020-09-24 17:25:27 +00:00
2020-09-25 18:40:19 +00:00
[![Build Status](https://drone.autonomic.zone/api/badges/compose-stacks/rocketchat/status.svg)](https://drone.autonomic.zone/compose-stacks/rocketchat)
2020-09-24 20:00:52 +00:00
[Rocket.chat] using Coöp Cloud ♥
2020-09-24 18:56:27 +00:00
<!-- metadata -->
* **Category**: Apps
* **Status**: ❷💛
* **Image**: [`rocketchat/rocket.chat`](https://hub.docker.com/r/rocketchat/rocket.chat/), ❶💚, upstream
* **Healthcheck**: Yes
* **Backups**: No
* **Email**: No
* **Tests**: ❷💛
* **SSO**: ❶💚 (OAuth)
<!-- endmetadata -->
2020-09-24 18:56:27 +00:00
1. Set up Docker Swarm and [`abra`]
2. Deploy [`compose-stacks/traefik`]
3. `cp .envrc.sample .envrc`
4. Edit `.envrc` - be sure to change `$DOMAIN` to something that resolves to
your Docker swarm box
5. `direnv allow` (or `. .envrc`)
6. Generate secrets:
```
abra secret_generate db_password v1
abra secret_generate admin_password v1
```
2020-09-24 18:56:27 +00:00
7. `abra deploy`
9. Open the configured domain in your browser to finish set-up
2020-09-24 19:00:43 +00:00
## Keycloak OpenID single sign-on
2020-09-24 17:25:27 +00:00
2020-09-24 19:00:43 +00:00
(Or use Rocket.Chat's [manual set-up guide](https://docs.rocket.chat/guides/administrator-guides/authentication/open-id-connect/keycloak))
1. Edit `.envrc`; uncomment and edit all the Accounts_OAuth lines, and the
`COMPOSE_FILE` line
2. `direnv allow` (or `source .envrc`)
3. Insert the OpenID secret into Docker: (FIXME add option for this to `abra`)
```
echo "your-secret-string-from-keycloak" | docker secret create "${STACK_NAME}_openid_key_${VERSION}" -
2020-09-24 19:00:43 +00:00
```
4. `abra deploy`
5. You should now have a "Login via Keycloak" option on the login page
2020-09-24 18:56:27 +00:00
[Rocket.chat]: https://rocket.chat
[`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra
[`compose-stacks/traefik`]: https://git.autonomic.zone/compose-stacks/traefik