coop-cloud/rocketchat
coop-cloud
/
rocketchat
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
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

45 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

Update README for new abra [ci skip]
2021-03-02 18:16:16 +00:00
# Rocket.chat
Initial import
2020-09-24 17:25:27 +00:00
compose-stacks → coop-cloud [ci skip]
2021-03-02 17:56:01 +00:00
[![Build Status](https://drone.autonomic.zone/api/badges/coop-cloud/rocketchat/status.svg)](https://drone.autonomic.zone/coop-cloud/rocketchat)
Add build status [ci skip]
2020-09-25 18:40:19 +00:00
Tweaks
2020-09-24 20:00:52 +00:00
[Rocket.chat] using Coöp Cloud ♥
Optional OAuth login
2020-09-24 18:56:27 +00:00
Follow new exciting README standard See coop-cloud/organising#31
2021-03-02 16:38:41 +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 -->
Add README heading [ci skip]
2021-03-02 18:14:24 +00:00
## Basic usage
Fix README links [ci skip]
2021-03-02 18:16:57 +00:00
1. Set up Docker Swarm and [`abra`][abra]
2. Deploy [`coop-cloud/traefik`][cc-traefik]
Fix type name in README [ci skip]
2021-03-02 18:24:31 +00:00
3. `abra app new rocketchat --secrets` (optionally with `--pass` if you'd like
Update README for new abra [ci skip]
2021-03-02 18:16:16 +00:00
to save secrets in `pass`)
4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
Optional OAuth login
2020-09-24 18:56:27 +00:00
your Docker swarm box
Update README for new abra [ci skip]
2021-03-02 18:16:16 +00:00
5. `abra app YOURAPPDOMAIN deploy`
Optional OAuth login
2020-09-24 18:56:27 +00:00
9. Open the configured domain in your browser to finish set-up
Document OpenID / OAuth login
2020-09-24 19:00:43 +00:00
## Keycloak OpenID single sign-on
Initial import
2020-09-24 17:25:27 +00:00
Document OpenID / OAuth login
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))
Update README for new abra [ci skip]
2021-03-02 18:16:16 +00:00
1. `abra app YOURAPPDOMAIN config`; uncomment and edit all the Accounts_OAuth
lines, and the `COMPOSE_FILE` line
3. Insert the OpenID secret into Docker: (FIXME document how to do this using `abra`)
Document OpenID / OAuth login
2020-09-24 19:00:43 +00:00
```
Add optional mail relay & change service names See compose-stacks/organising#19
2020-09-27 20:58:27 +00:00
echo "your-secret-string-from-keycloak" | docker secret create "${STACK_NAME}_openid_key_${VERSION}" -
Document OpenID / OAuth login
2020-09-24 19:00:43 +00:00
```
Update README for new abra [ci skip]
2021-03-02 18:16:16 +00:00
5. `abra app YOURAPPDOMAIN deploy`
Document OpenID / OAuth login
2020-09-24 19:00:43 +00:00
5. You should now have a "Login via Keycloak" option on the login page
Optional OAuth login
2020-09-24 18:56:27 +00:00
[Rocket.chat]: https://rocket.chat
Update README for new abra [ci skip]
2021-03-02 18:16:16 +00:00
[abra]: https://git.autonomic.zone/coop-cloud/abra
[cc-traefik]: https://git.autonomic.zone/coop-cloud/traefik