mirror of
https://github.com/hanzoai/kms.git
synced 2026-10-17 11:18:16 +00:00
zeekay
b3714c0c90
Rebrand all Infisical references introduced by 766 upstream commits: - 481 documentation files (mdx/md) - 238 TypeScript files (frontend UI, backend services, email templates) - 29 Helm chart files - 14 CI/CD workflow files - 13 Docker/compose files - Remove 28 obsolete Infisical-specific files
53 lines
2.5 KiB
Plaintext
53 lines
2.5 KiB
Plaintext
---
|
|
title: "GitLab SSO"
|
|
description: "Learn how to configure GitLab SSO for Hanzo KMS."
|
|
---
|
|
|
|
Using GitLab SSO on a self-hosted instance of Hanzo KMS requires configuring an OAuth application in GitLab and registering your instance with it.
|
|
|
|
<Steps>
|
|
<Step title="Create an OAuth application in GitLab">
|
|
Navigate to your user Settings > Applications to create a new GitLab application.
|
|
|
|
|
|
|
|
|
|
Create the application. As part of the form, set the **Redirect URI** to `https://your-domain.com/api/v1/sso/gitlab`.
|
|
Note that only `read_user` is required as part of the **Scopes** configuration.
|
|
|
|
|
|
|
|
<Note>
|
|
If you have a GitLab group, you can create an OAuth application under it
|
|
in your group Settings > Applications.
|
|
</Note>
|
|
</Step>
|
|
<Step title="Add your OAuth application credentials to Hanzo KMS">
|
|
Obtain the **Application ID** and **Secret** for your GitLab application.
|
|
|
|
|
|
|
|
Back in your Hanzo KMS instance, make sure to set the following environment variables:
|
|
|
|
- `CLIENT_ID_GITLAB_LOGIN`: The **Client ID** of your GitLab application.
|
|
- `CLIENT_SECRET_GITLAB_LOGIN`: The **Secret** of your GitLab application.
|
|
- (optional) `URL_GITLAB_LOGIN`: The URL of your self-hosted instance of GitLab where the OAuth application is registered. If no URL is passed in, this will default to `https://gitlab.com`.
|
|
- `AUTH_SECRET`: A secret key used for signing and verifying JWT. This can be a random 32-byte base64 string generated with `openssl rand -base64 32`.
|
|
- `SITE_URL`: The URL of your self-hosted instance of Hanzo KMS - should be an absolute URL including the protocol (e.g. https://kms.hanzo.ai)
|
|
|
|
Once added, restart your Hanzo KMS instance and log in with GitLab.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## FAQ
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Why is GitLab SSO not working?">
|
|
It is likely that you have misconfigured your self-hosted instance of Hanzo KMS. You should:
|
|
|
|
- Check that you have set the `CLIENT_ID_GITLAB_LOGIN`, `CLIENT_SECRET_GITLAB_LOGIN`,
|
|
`AUTH_SECRET`, and `SITE_URL` environment variables.
|
|
- Check that the **Redirect URI** specified in GitLab matches the `SITE_URL` environment variable.
|
|
For example, if the former is `https://kms.hanzo.ai/api/v1/sso/gitlab` then the latter should be `https://kms.hanzo.ai`.
|
|
</Accordion>
|
|
</AccordionGroup> |