You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/authentication/proc-enabling-authentication-with-github.adoc
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,7 @@ and provision the users and groups from GitHub to the {product-short} software c
6
6
7
7
.Prerequisites
8
8
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
9
+
9
10
* You have sufficient permissions in GitHub to create and manage a link:https://docs.github.com/en/apps/overview[GitHub App].
10
11
11
12
.Procedure
@@ -22,8 +23,10 @@ Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
22
23
23
24
Authorization callback URL::
24
25
Enter your {product-short} authentication backend URL: `pass:c,a,q[{my-product-url}/api/auth/github/handler/frame]`.
26
+
25
27
Webhook::
26
-
Uncheck "Active", as this is not needed for authentication and catalog providers.
28
+
Uncheck "Active", as this is not needed for authentication and catalog providers.
29
+
27
30
Organization permissions::
28
31
Enable `Read-only` access to *Members*.
29
32
@@ -41,7 +44,7 @@ Select `Only on this account`.
41
44
42
45
. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets].
43
46
You can use these secrets in the {product-short} configuration files by using their respective environment variable name.
. To provision GitHub users and groups to the {product-short} software catalog, add the `catalog.providers.githubOrg` section to your custom {product-short} `{my-app-config-file}` configuration file:
70
72
+
@@ -90,8 +92,7 @@ catalog:
90
92
91
93
`id`::
92
94
Enter a stable identifier for this provider, such as `githuborg`.
93
-
Entities from this provider will be associated with this identifier,
94
-
therefore you should take care not to change it over time since that might lead to orphaned entities and/or conflicts.
95
+
Entities from this provider will be associated with this identifier, therefore you should take care not to change it over time since that might lead to orphaned entities and/or conflicts.
95
96
96
97
`githubUrl`::
97
98
Enter the configured secret variable name: `${AUTHENTICATION_GITHUB_HOST_DOMAIN}`.
Copy file name to clipboardExpand all lines: modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,14 +7,15 @@ When a repository contains a `catalog-info.yaml` file, {product-short} ingests t
7
7
8
8
.Prerequisites
9
9
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
10
+
10
11
* You have sufficient permissions in GitHub to create and manage a link:https://docs.github.com/en/apps/overview[GitHub App].
11
12
12
13
.Procedure
13
14
. To allow {product-short} to access the GitHub API, create a GitHub App.
14
15
Opt for a GitHub App instead of an OAuth app to use fine-grained permissions, gain more control over which repositories the application can access, and use short-lived tokens.
15
16
16
17
.. link:https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app[Register a GitHub App] with the following configuration:
17
-
+
18
+
18
19
GitHub App name::
19
20
Enter a unique name identifying your GitHub App, such as `integrating-with-rhdh-__<GUID>__`.
20
21
@@ -77,7 +78,8 @@ Environments::::
77
78
`Read & write` (if templates include GitHub Environments)
78
79
79
80
Organization permissions::
80
-
* Enable `Read-only` access to *Members*.
81
+
Members:::
82
+
`Read-only`
81
83
82
84
Where can this GitHub App be installed?::
83
85
Select `Only on this account`.
@@ -98,7 +100,7 @@ Select `Only on this account`.
98
100
99
101
. To add your GitHub credentials to {product-short}, add the following key/value pairs to link:{configuring-dynamic-plugins-book-url}#provisioning-your-custom-configuration[your {product-short} secrets].
100
102
You can use these secrets in the {product-short} configuration files by using their respective environment variable name.
0 commit comments