Skip to content

Commit 6225ba0

Browse files
Improve documentation following deployment test in Kubernetes using a GitHub App (#266)
1 parent 0cc3430 commit 6225ba0

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

DEPLOYMENT.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -197,10 +197,9 @@ or navigate using UI:
197197
5. Set the scopes:
198198
- Select **Organization permissions**.
199199
- Under **GitHub Copilot Business**, select **Access: Read-only**.
200-
6. Click on 'Create GitHub App' and, in the following page, click on 'Generate a new client secret'. (IMPORTANT: _**Save it for later**_)
201-
7. Install the app in the organization:
200+
- Under **Members**, select **Access: Read-only**.
201+
6. Click on 'Create GitHub App' and, in the following page, click on 'Generate a new client secret'.
202+
7. Note the `Client ID` and `Client Secret` (copy it to a secure location). This is required for the application to authenticate with GitHub.
203+
8. Install the app in the organization:
202204
- Go to "Install App".
203205
- Select your organization.
204-
8. Generate a new `Client Secret` and copy it to a secure location. This is required for the application to authenticate with GitHub.
205-
206-
Note the `Client ID` and `Client Secret`.

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ can be overriden by route parameters, e.g.
165165
- `http://localhost:3000/enterprises/octo-demo-ent/teams/the-a-team`
166166
- `http://localhost:3000/orgs/mocked-org?mock=true`
167167

168-
#### NUXT_PUBLIC_SCOPE
168+
#### NUXT_PUBLIC_SCOPE (Required!)
169169

170170
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'.
171171

@@ -227,22 +227,28 @@ For more information see [Nuxt Sessions and Authentication](https://nuxt.com/doc
227227
228228
#### NUXT_PUBLIC_USING_GITHUB_AUTH
229229

230-
Default is `false`. When set to `true`, GitHub OAuth App Authentication will be performed to verify users' access to the dashboard.
230+
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.
231231

232232
Variables required for GitHub Auth are:
233-
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).
233+
1. `NUXT_OAUTH_GITHUB_CLIENT_ID` - client ID of the GitHub App.
234234
2. `NUXT_OAUTH_GITHUB_CLIENT_SECRET` - client secret of the GitHub App.
235235
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.
236236

237237
>[!WARNING]
238238
> 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.
239239
240-
#### Support for HTTP Proxy HTTP_PROXY
240+
#### HTTP_PROXY
241241

242242
Solution supports HTTP Proxy settings when running in corporate environment. Simple set `HTTP_PROXY` environment variable.
243243

244244
For custom CA use environment variable `CUSTOM_CA_PATH` to load the certificate into proxy agent options.
245245

246+
#### NITRO_PORT
247+
248+
Default is `80` in the [Dockerfile](Dockerfile). It defines the port number that Nitro (Nuxt’s server engine) will listen on.
249+
250+
For example, it should be set to a number between 1024 and 49151 if the application is run as a non-root user.
251+
246252
## Install Dependencies
247253

248254
```bash

0 commit comments

Comments
 (0)