-
Notifications
You must be signed in to change notification settings - Fork 1
docs: add a GitHub sign-in page with the IP allow list addresses #417
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+67
−1
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| title: GitHub sign-in | ||
| description: "Sign in to Kosli with a GitHub account, and allow Kosli's sign-in traffic through a GitHub IP allow list." | ||
| icon: "github" | ||
| --- | ||
|
|
||
| Kosli supports signing in with a GitHub account. If your organization uses an identity provider, | ||
| [single sign-on](/administration/authentication/single_sign_on) is the alternative, and | ||
| [Magic Link](/administration/authentication/magic_link) works without one. | ||
|
|
||
| ## Before you begin | ||
|
|
||
| Your GitHub account must have a verified email address, otherwise sign-in fails. Check the status of | ||
| your email addresses at [github.com/settings/emails](https://github.com/settings/emails). | ||
|
|
||
| ## Sign in with GitHub | ||
|
|
||
| <Steps> | ||
| <Step title="Open Kosli"> | ||
| Open the Kosli web app for your region: | ||
|
|
||
| - EU: [app.kosli.com](https://app.kosli.com) | ||
| - US: [app.us.kosli.com](https://app.us.kosli.com) | ||
| </Step> | ||
| <Step title="Choose GitHub"> | ||
| Select the GitHub option on the sign-in page. GitHub asks you to authorize Kosli the first time | ||
| you sign in. | ||
| </Step> | ||
| <Step title="Return to Kosli"> | ||
| Once GitHub confirms the authorization, you are signed in to Kosli. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| ## GitHub IP allow lists | ||
|
|
||
| If your GitHub organization or enterprise restricts access with an | ||
| [IP allow list](https://docs.github.com/en/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization), | ||
| GitHub sign-in to Kosli fails until Kosli's sign-in traffic is allowed. | ||
|
|
||
| Kosli uses [Descope](https://www.descope.com/) as its identity provider. After you authorize Kosli in | ||
| GitHub, Descope calls GitHub from a fixed set of IP addresses to complete the sign-in. GitHub rejects | ||
| those calls unless the addresses are on your allow list. | ||
|
|
||
| Add the addresses for the Kosli instance you sign in to. Only one set is needed. | ||
|
|
||
| ### app.kosli.com (EU) | ||
|
|
||
| - `3.72.207.40` | ||
| - `3.74.59.88` | ||
| - `3.121.31.67` | ||
|
|
||
| ### app.us.kosli.com (US) | ||
|
|
||
| - `35.170.24.133` | ||
| - `3.212.215.29` | ||
| - `52.44.167.251` | ||
|
|
||
| <Info> | ||
| These are Descope's **Project Static IPs**. Descope publishes the current list at | ||
| [Public static IPs](https://docs.descope.com/how-to-deploy-to-production/public-static-ips). If sign-in | ||
| stops working after you have added the addresses above, check that page for changes. | ||
| </Info> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -26,7 +26,7 @@ For anything automated, use a service account. Personal API keys inherit your us | |||||
| - EU: [app.kosli.com](https://app.kosli.com) | ||||||
| - US: [app.us.kosli.com](https://app.us.kosli.com) | ||||||
|
|
||||||
| Depending on how your organization is set up, you'll sign in with single sign-on, [Magic Link](/administration/authentication/magic_link) or GitHub. | ||||||
| Depending on how your organization is set up, you'll sign in with single sign-on, [Magic Link](/administration/authentication/magic_link) or [GitHub](/administration/authentication/github_login). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Now that GitHub is a link, single sign-on is the only one of the three sign-in methods in this sentence left unlinked — it has a page at
Suggested change
|
||||||
| </Step> | ||||||
| <Step title="Create a key"> | ||||||
| - **For CI/CD**, follow [Service accounts](/administration/authentication/service_accounts) to create a service account and generate its first API key. | ||||||
|
|
@@ -52,6 +52,7 @@ For CLI usage, basic auth, and full examples, see [API authentication methods](/ | |||||
|
|
||||||
| - [Single sign-on](/administration/authentication/single_sign_on) — configure sign-in through your identity provider. | ||||||
| - [Magic Link](/administration/authentication/magic_link) — sign in with an emailed link, without an identity provider. | ||||||
| - [GitHub sign-in](/administration/authentication/github_login) — sign in with a GitHub account, including GitHub IP allow lists. | ||||||
| - [Service accounts](/administration/authentication/service_accounts) — admin lifecycle for machine credentials. | ||||||
| - [API key rotation](/administration/authentication/api_key_rotation) — how rotation works, with a [step-by-step tutorial](/tutorials/rotating_api_keys). | ||||||
| - [Roles in Kosli](/administration/managing_users/roles_in_kosli) — what users and service accounts can do at each role. | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.