Skip to content

Commit 32f6d6e

Browse files
committed
implemented suggestions
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent e49edf2 commit 32f6d6e

File tree

2 files changed

+7
-12
lines changed

2 files changed

+7
-12
lines changed

modules/authentication/proc-enabling-authentication-with-github.adoc

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,14 @@ Opt for a GitHub App instead of an OAuth app to use fine-grained permissions, ga
1414
.. 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:
1515

1616
GitHub App name::
17-
Enter a unique name identifying your GitHub App, such as `Authenticating-with-{product-very-short}-__<GUID>__`.
17+
Enter a unique name identifying your GitHub App, such as `authenticating-with-{product-very-short}-__<GUID>__`.
1818

1919
Homepage URL::
2020
Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
2121

2222
Authorization callback URL::
2323
Enter your {product-short} authentication backend URL: `pass:c,a,q[{my-product-url}/api/auth/github/handler/frame]`.
2424

25-
Webhook URL:: Enter your {product-short} URL: `pass:c,a,q[{my-product-url}]`.
26-
27-
Repository permissions::
28-
Not required.
29-
3025
Organization permissions::
3126
Enable `Read-only` access to *Members*.
3227

@@ -107,14 +102,14 @@ auth:
107102
providers:
108103
github:
109104
production:
110-
clientId: ${AUTH_GITHUB_CLIENT_ID}
111-
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
105+
clientId: ${AUTHENTICATION_GITHUB_CLIENT_ID}
106+
clientSecret: ${AUTHENTICATION_GITHUB_CLIENT_SECRET}
112107
signInPage: github
113108
----
114109
+
115110
`environment: production`::
116111
Mark the environment as `production` and disable the Guest login option in the {product-short} login page.
117-
`clientId: ${AUTH_GITHUB_CLIENT_ID}` and `clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}`::
112+
`clientId: ${AUTHENTICATION_GITHUB_CLIENT_ID}` and `clientSecret: ${AUTHENTICATION_GITHUB_CLIENT_SECRET}`::
118113
Apply the GitHub credentials configured in your {product-short} secrets.
119114
`signInPage: github`::
120115
To enable the GitHub provider as your {product-short} sign-in provider.
@@ -181,8 +176,8 @@ auth:
181176
providers:
182177
github:
183178
production:
184-
clientId: ${AUTH_GITHUB_CLIENT_ID}
185-
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
179+
clientId: ${AUTHENTICATION_GITHUB_CLIENT_ID}
180+
clientSecret: ${AUTHENTICATION_GITHUB_CLIENT_SECRET}
186181
signIn:
187182
resolvers:
188183
- resolver: usernameMatchingUserEntityName

modules/integrating-with-github/proc-enabling-github-repository-discovery.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ plugins:
9393
disabled: false
9494
----
9595

96-
. To enable GitHub integration with a different authentication provider, add the `catalog.providers.github` and the `integration.github` sections to your custom {product-short} `{my-app-config-file}` configuration file:
96+
. Configure the GitHub integration, by adding the `catalog.providers.github` and the `integration.github` sections to your custom {product-short} `{my-app-config-file}` configuration file:
9797
+
9898
.`{my-app-config-file}` file fragment with mandatory fields to enable GitHub integration
9999
[source,yaml,subs="+quotes"]

0 commit comments

Comments
 (0)