Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions assemblies/assembly-authenticating-with-github.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="assembly-auth-provider-github"]
= Enabling the GitHub authentication provider
[id="authenticating-with-github"]
= Authenticating with GitHub

To authenticate users with GitHub or GitHub Enterprise:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,39 @@ auth:
enterpriseInstanceUrl: ${GITHUB_HOST_DOMAIN}
----

[TIP]
====
To enable GitHub integration with a different authentication provider, complete the following configurations:

* Add the GitHub provider to the existing `auth` section.
* Keep the `signInPage` section from your authentication provider configuration.

.`app-config-rhdh.yaml` fragment with mandatory fields to enable GitHub integration and use a different authentication provider
[source,yaml,subs="+quotes"]
----
auth:
environment: production
providers:
github:
production:
clientId: ${AUTH_GITHUB_CLIENT_ID}
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
__<your_other_authentication_providers_configuration>__
integrations:
github:
- host: ${GITHUB_HOST_DOMAIN}
apps:
- appId: ${AUTH_GITHUB_APP_ID}
clientId: ${AUTH_GITHUB_CLIENT_ID}
clientSecret: ${GITHUB_CLIENT_SECRET}
webhookUrl: ${GITHUB_WEBHOOK_URL}
webhookSecret: ${GITHUB_WEBHOOK_SECRET}
privateKey: |
${GITHUB_PRIVATE_KEY_FILE}
signInPage: __<your_main_authentication_provider>__
----
====

--

.Verification
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can enable the Bulk Import feature for users and give them the necessary permissions to access it.

.Prerequisites
* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration].
* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub integration].

.Procedure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
In {product}, you can select your GitHub repositories and automate their onboarding to the {product-short} catalog.

.Prerequisites
* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration].
* You have xref:enabling-and-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature and gave access to it].

.Procedure
Expand Down