-
Notifications
You must be signed in to change notification settings - Fork 301
Improve documentation following deployment test in Kubernetes using a GitHub App #266
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
karpikpl
merged 1 commit into
github-copilot-resources:main
from
sebastienbonami:fix/documentation
Sep 12, 2025
Merged
Changes from all commits
Commits
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
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -165,7 +165,7 @@ can be overriden by route parameters, e.g. | |||||
| - `http://localhost:3000/enterprises/octo-demo-ent/teams/the-a-team` | ||||||
| - `http://localhost:3000/orgs/mocked-org?mock=true` | ||||||
|
|
||||||
| #### NUXT_PUBLIC_SCOPE | ||||||
| #### NUXT_PUBLIC_SCOPE (Required!) | ||||||
|
|
||||||
| The `NUXT_PUBLIC_SCOPE` environment variable in the `.env` file determines the default scope of the API calls made by the application. It can be set to 'enterprise', 'organization', 'team-organization' or 'team-enterprise'. | ||||||
|
|
||||||
|
|
@@ -227,22 +227,28 @@ For more information see [Nuxt Sessions and Authentication](https://nuxt.com/doc | |||||
|
|
||||||
| #### NUXT_PUBLIC_USING_GITHUB_AUTH | ||||||
|
|
||||||
| Default is `false`. When set to `true`, GitHub OAuth App Authentication will be performed to verify users' access to the dashboard. | ||||||
| Default is `false`. When set to `true`, GitHub OAuth App Authentication will be performed to verify users' access to the dashboard. For this, a GitHub App must be registered and installed in the enterprise/org. See [Github App Registration](DEPLOYMENT.md#github-app-registration) for the steps to follow. | ||||||
|
|
||||||
| Variables required for GitHub Auth are: | ||||||
| 1. `NUXT_OAUTH_GITHUB_CLIENT_ID` - client ID of the GitHub App registered and installed in the enterprise/org with permissions listed in [NUXT_GITHUB_TOKEN](#NUXT_GITHUB_TOKEN). | ||||||
| 1. `NUXT_OAUTH_GITHUB_CLIENT_ID` - client ID of the GitHub App. | ||||||
| 2. `NUXT_OAUTH_GITHUB_CLIENT_SECRET` - client secret of the GitHub App. | ||||||
| 3. [Optional] `NUXT_OAUTH_GITHUB_CLIENT_SCOPE` for scope requests when using OAuth App instead of GitHub App. See [Github docs](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps) for details. | ||||||
|
|
||||||
| >[!WARNING] | ||||||
| > Only users with permissions (scopes listed in [NUXT_GITHUB_TOKEN](#NUXT_GITHUB_TOKEN)) can view copilot metrics, GitHub uses the authenticated users permissions to make API calls for data. | ||||||
|
|
||||||
| #### Support for HTTP Proxy HTTP_PROXY | ||||||
| #### HTTP_PROXY | ||||||
|
|
||||||
| Solution supports HTTP Proxy settings when running in corporate environment. Simple set `HTTP_PROXY` environment variable. | ||||||
|
||||||
| Solution supports HTTP Proxy settings when running in corporate environment. Simple set `HTTP_PROXY` environment variable. | |
| Solution supports HTTP Proxy settings when running in corporate environment. Simply set `HTTP_PROXY` environment variable. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub should be capitalized consistently: 'Github App Registration' should be 'GitHub App Registration'.