Skip to content

Commit ed7cb6a

Browse files
Apply suggestions from code review
Co-authored-by: Jana Vrbkova <[email protected]>
1 parent 2d23970 commit ed7cb6a

5 files changed

+10
-11
lines changed

modules/authentication/proc-enabling-user-authentication-with-github-as-an-auxiliary-authentication-provider.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
[id="enabling-user-authentication-with-github-as-an-auxiliary-authentication-provider"]
44
= Enabling user authentication with GitHub as an auxiliary authentication provider
55

6-
If your primary authentication provider is not GitHub, users may lack the permissions needed for templates or plugins that require GitHub access. The recommended solution is to configure GitHub as an auxiliary authentication provider. This approach uses the primary provider for user identity management and the auxiliary provider to grant the necessary GitHub permissions, without re-resolving the user's identity.
6+
If your primary authentication provider is not GitHub, users might lack the permissions needed for templates or plugins that require GitHub access. The recommended solution is to configure GitHub as an auxiliary authentication provider. This approach uses the primary provider for user identity management and the auxiliary provider to grant the necessary GitHub permissions, without re-resolving the user's identity.
77

8-
Allow users to access these features by configuring GitHub as an auxiliary authentication provider.
8+
Give users access to these features by configuring GitHub as an auxiliary authentication provider.
99

1010
.Prerequisites
1111
include::snip-enabling-user-authentication-with-github-common-prerequisites.adoc[]

modules/authentication/snip-enabling-user-authentication-with-github-common-first-steps.adoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Authorization callback URL::
1616
Enter your {product-short} authentication backend URL: `pass:c,a,q[{my-product-url}/api/auth/github/handler/frame]`.
1717

1818
Webhook::
19-
Clear "Active", as this is not needed for authentication and catalog providers.
19+
Clear "Active".
2020

2121
Organization permissions::
2222
Enable `Read-only` access to *Members*.
@@ -33,7 +33,7 @@ Select `Only on this account`.
3333
* **Client ID**
3434
* **Client secret**
3535
36-
. To add your GitHub credentials to {product-short}, add the following key/value pairs to {configuring-book-link}#provisioning-your-custom-configuration[your {product-short} secrets].
36+
. Add your GitHub credentials to {product-short} by adding the following key/value pairs to {configuring-book-link}#provisioning-your-custom-configuration[your {product-short} secrets].
3737
You can use these secrets in the {product-short} configuration files by using their environment variable name.
3838

3939
`GITHUB_CLIENT_ID`::
@@ -48,8 +48,7 @@ Enter the GitHub host domain: `github.com`.
4848
`GITHUB_ORG`::
4949
Enter your GitHub organization name, such as `__<your_github_organization_name>__`.
5050

51-
. Enable the GitHub catalog provider plugin in your `dynamic-plugins.yaml` file.
52-
This plugin imports GitHub users and groups to the {product-short} software catalog.
51+
. Enable the GitHub catalog provider plugin in your `dynamic-plugins.yaml` file to import GitHub users and groups to the {product-short} software catalog.
5352
+
5453
[source,yaml]
5554
----
@@ -58,7 +57,7 @@ plugins:
5857
disabled: false
5958
----
6059

61-
. Enable provisioning GitHub users and groups to the {product-short} software catalog, by adding the GitHub catalog provider section to your `{my-app-config-file}` file:
60+
. Enable provisioning GitHub users and groups to the {product-short} software catalog by adding the GitHub catalog provider section to your `{my-app-config-file}` file:
6261
+
6362
[id=githubProviderId]
6463
[source,yaml]

modules/authentication/snip-enabling-user-authentication-with-github-optional-authentication-provider-steps.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ Enter `true` to configure the sign-in resolver to bypass the user provisioning r
5454
+
5555
[WARNING]
5656
====
57-
In production more, do not enable `dangerouslyAllowSignInWithoutUserInCatalog` in production.
57+
In production more, do not enable `dangerouslyAllowSignInWithoutUserInCatalog`.
5858
====

modules/authentication/snip-enabling-user-authentication-with-rhbk-common-authentication-provider-steps.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ signInPage: oidc
2020
Mark the environment as `production` to hide the Guest login in the {product-short} home page.
2121

2222
`metadataUrl`, `clientId`, `clientSecret`::
23-
To configure the OIDC provider with your secrets.
23+
Configure the OIDC provider with your secrets.
2424

2525
`prompt`::
2626
Enter `auto` to allow the identity provider to automatically determine whether to prompt for credentials or bypass the login redirect if an active {rhsso} session exists.
2727
+
28-
The identity provider defaults to `none`, which assumes that you are already logged in and rejects sign-in requests without an active session.
28+
The identity provider defaults to `none`, which assumes that you are already logged in. Sign-in requests without an active session are rejected.
2929

3030
`signInPage`::
3131
Enter `oidc` to enable the OIDC provider as default sign-in provider.

modules/authentication/snip-enabling-user-authentication-with-rhbk-optional-authentication-provider-steps.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Configure the sign-in resolver to bypass the user provisioning requirement in th
7373
+
7474
[WARNING]
7575
====
76-
Use this option to explore {product-short} features, but do not use it in production.
76+
In production mode, do not enable the `dangerouslyAllowSignInWithoutUserInCatalog` option.
7777
====
7878

7979
`sessionDuration`::

0 commit comments

Comments
 (0)