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
+25-5Lines changed: 25 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,17 +55,15 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri
55
55
+
56
56
`AUTH_GITHUB_APP_ID`:: Enter the saved **App ID**.
57
57
`AUTH_GITHUB_CLIENT_ID`:: Enter the saved **Client ID**.
58
-
+
59
-
Optional: enter additional secrets. The additional secrets are not required for authentication, but for further integration with GitHub, including:
60
-
+
61
58
`GITHUB_HOST_DOMAIN`:: Enter your GitHub host domain: `pass:c[https://github.com]` unless you are using GitHub Enterprise.
62
59
`GITHUB_ORGANIZATION`:: Enter your GitHub organization name, such as `__<your_github_organization_name>__'.
63
60
`GITHUB_ORG_URL`:: Enter `$GITHUB_HOST_DOMAIN/$GITHUB_ORGANIZATION`.
64
61
`GITHUB_CLIENT_SECRET`:: Enter the saved **Client Secret**.
65
62
`GITHUB_PRIVATE_KEY_FILE`:: Enter the saved **Private key**.
63
+
`GITHUB_WEBHOOK_URL`:: Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
66
64
`GITHUB_WEBHOOK_SECRET`:: Enter the saved *Webhook secret*.
67
65
68
-
. To set up the GitHub authentication provider in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
66
+
. To set up the GitHub authentication provider and enable integration with the GitHub API in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
69
67
+
70
68
--
71
69
.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with GitHub
@@ -78,13 +76,24 @@ auth:
78
76
production:
79
77
clientId: ${AUTH_GITHUB_CLIENT_ID}
80
78
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
79
+
integrations:
80
+
github:
81
+
- host: ${GITHUB_HOST_DOMAIN}
82
+
apps:
83
+
- appId: ${AUTH_GITHUB_APP_ID}
84
+
clientId: ${AUTH_GITHUB_CLIENT_ID}
85
+
clientSecret: ${GITHUB_CLIENT_SECRET}
86
+
webhookUrl: ${GITHUB_WEBHOOK_URL}
87
+
webhookSecret: ${GITHUB_WEBHOOK_SECRET}
88
+
privateKey: |
89
+
${GITHUB_PRIVATE_KEY_FILE}
81
90
signInPage: github
82
91
----
83
92
84
93
`environment: production`::
85
94
Mark the environment as `production` to hide the Guest login in the {product-short} home page.
0 commit comments