Add documentation and new healthcheck
This commit is contained in:
28
README.md
28
README.md
@ -1,24 +1,36 @@
|
||||
# gitlab
|
||||
|
||||
> One line description of the recipe
|
||||
> GitLab server, using GitLab omnibus
|
||||
|
||||
<!-- metadata -->
|
||||
|
||||
* **Category**: Apps
|
||||
* **Status**: 0
|
||||
* **Image**: [`gitlab`](https://hub.docker.com/r/gitlab), 4, upstream
|
||||
* **Healthcheck**: No
|
||||
* **Backups**: No
|
||||
* **Healthcheck**: Yes
|
||||
* **Backups**: Yes
|
||||
* **Email**: No
|
||||
* **Tests**: No
|
||||
* **SSO**: No
|
||||
* **SSO**: 1 (OAuth)
|
||||
|
||||
<!-- endmetadata -->
|
||||
|
||||
## Quick start
|
||||
|
||||
* `abra app new gitlab --secrets`
|
||||
* `abra app config <app-name>`
|
||||
* `abra app deploy <app-name>`
|
||||
- `abra app new gitlab --secrets`
|
||||
- `abra app config <app-name>`
|
||||
- Set REGISTRY_DOMAIN to a domain that you want to use for the GitLab container registry (optional)
|
||||
- Set PAGES_DOMAIN to a domain that you want to use for the GitLab Pages service. NOTE: This cannot be a subdomain of the domain GitLab is hosted under. (optional)
|
||||
- Set GITLAB_ROOT_EMAIL to an appropriate email address
|
||||
- `abra app deploy <app-name>`
|
||||
|
||||
For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).
|
||||
### SSO Configuration
|
||||
|
||||
- Create a Provider and Application in Authentik: https://docs.goauthentik.io/integrations/services/gitlab/#openid-connect-auth
|
||||
- Note the Provider ID and Secret
|
||||
- Run `abra app config <app-name>`
|
||||
- Uncomment the Authentik Configuration config block
|
||||
- Set `SSO_PROVIDER_ID` to the Authentik Provider ID
|
||||
- Run `abra app secret insert <app-name> sso_provider_secret v1 <Authentik Provider Secret>`
|
||||
|
||||
For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).
|
Reference in New Issue
Block a user