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.6 KiB
Plaintext
53 lines
2.6 KiB
Plaintext
---
|
|
title: "GitHub SSO"
|
|
description: "Learn how to configure GitHub SSO for Hanzo KMS."
|
|
---
|
|
|
|
Using GitHub SSO on a self-hosted instance of Hanzo KMS requires configuring an OAuth2 application in GitHub and registering your instance with it.
|
|
|
|
<Steps>
|
|
<Step title="Create an OAuth application in GitHub">
|
|
Navigate to your user Settings > Developer settings > OAuth Apps to create a new GitHub OAuth application.
|
|
|
|
|
|
|
|
|
|
|
|
Create the OAuth application. As part of the form, set the **Homepage URL** to your self-hosted domain `https://your-domain.com`
|
|
and the **Authorization callback URL** to `https://your-domain.com/api/v1/sso/github`.
|
|
|
|
|
|
|
|
<Note>
|
|
If you have a GitHub organization, you can create an OAuth application under it
|
|
in your organization Settings > Developer settings > OAuth Apps > New Org OAuth App.
|
|
</Note>
|
|
</Step>
|
|
<Step title="Add your OAuth application credentials to Hanzo KMS">
|
|
Obtain the **Client ID** and generate a new **Client Secret** for your GitHub OAuth application.
|
|
|
|
|
|
|
|
Back in your Hanzo KMS instance, make sure to set the following environment variables:
|
|
|
|
- `CLIENT_ID_GITHUB_LOGIN`: The **Client ID** of your GitHub OAuth application.
|
|
- `CLIENT_SECRET_GITHUB_LOGIN`: The **Client Secret** of your GitHub OAuth application.
|
|
- `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 GitHub.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## FAQ
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Why is GitHub 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_GITHUB_LOGIN`, `CLIENT_SECRET_GITHUB_LOGIN`,
|
|
`AUTH_SECRET`, and `SITE_URL` environment variables.
|
|
- Check that the **Authorization callback URL** specified in GitHub matches the `SITE_URL` environment variable.
|
|
For example, if the former is `https://kms.hanzo.ai/api/v1/sso/github` then the latter should be `https://kms.hanzo.ai`.
|
|
</Accordion>
|
|
</AccordionGroup> |