Skip to content

Commit 8d96ec8

Browse files
authored
chore: Update GitHub instructions with App registration instructions (#3070)
* chore: Update GitHub instructions with App registration instructions * fixup! chore: Update GitHub instructions with App registration instructions
1 parent f9ee350 commit 8d96ec8

2 files changed

Lines changed: 43 additions & 2 deletions

File tree

modules/administration-guide/pages/configuring-oauth-2-for-github.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@
99

1010
To enable users to work with a remote Git repository that is hosted on GitHub:
1111

12-
. Set up the GitHub OAuth App (OAuth 2.0).
13-
. Apply the GitHub OAuth App Secret.
12+
. Set up a link:https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps#about-github-apps[GitHub App] or a link:https://docs.github.com/en/apps/oauth-apps/using-oauth-apps[OAuth App].
13+
. Apply the GitHub App or OAuth App Secret.
1414

1515
include::partial$proc_setting-up-the-github-oauth-app.adoc[leveloffset=+1]
1616

17+
include::partial$proc_setting-up-the-github-app.adoc[leveloffset=+1]
18+
1719
include::partial$proc_applying-the-github-oauth-app-secret.adoc[leveloffset=+1]
1820

1921
To configure OAuth 2.0 for another GitHub provider,
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
:_content-type: PROCEDURE
2+
:description: Setting up the GitHub App
3+
:keywords: github, github-app
4+
:navtitle: Setting up the GitHub App
5+
// :page-aliases:
6+
7+
[id="setting-up-the-github-app"]
8+
= Setting up the GitHub App
9+
10+
Set up a GitHub App to enable users to work with GitHub repositories.
11+
12+
.Prerequisites
13+
14+
* You are logged in to GitHub.
15+
16+
.Procedure
17+
18+
. Register a GitHub app, see: link:https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app#registering-a-github-app[Registering a GitHub App].
19+
. Enter the following values:
20+
.. *GitHub App name*: `<__application name__>`
21+
.. *Homepage URL*: `pass:c,a,q[{prod-url}]/`
22+
.. *Callback URL*: `pass:c,a,q[{prod-url}]/api/oauth/callback`
23+
.. Deselect the `Active` check-box in the `Webhook` section.
24+
.. Under *Permissions & events*, set the *Contents* repository permission to *Read and Write*.
25+
26+
. Click *Create GitHub App*.
27+
28+
. Click *Generate a new client secret*.
29+
30+
. Copy and save the *GitHub App Client Secret* for use when applying the GitHub App Secret.
31+
32+
. Copy and save the *GitHub App Client ID* for use when applying the GitHub App Secret.
33+
34+
. Install the GitHub App, see: link:https://docs.github.com/en/apps/using-github-apps/installing-your-own-github-app#installing-your-own-github-app[Installing your own GitHub App]
35+
36+
37+
.Additional resources
38+
39+
* link:https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app[GitHub Docs: Registering a GitHub App]

0 commit comments

Comments
 (0)