fix(config): fix configuration for GitHub Auth (janus-idp#512)

RedHatInsights · Sep 8, 2023 · 99c42b5 · 99c42b5
1 parent 1ca06cf
commit 99c42b5
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 22 deletions.
diff --git a/.changeset/popular-melons-tell.md b/.changeset/popular-melons-tell.md
@@ -0,0 +1,7 @@
+---
+'app': patch
+---
+
+Fixed configuration for GitHub Auth plugin.
+
+GitHub Auth now uses `AUTH_GITHUB_CLIENT_ID` and `AUTH_GITHUB_CLIENT_SECRET` variables.
diff --git a/app-config.yaml b/app-config.yaml
@@ -174,8 +174,8 @@ auth:
     # Plugin: GitHub
     github:
       development:
-        clientId: ${GITHUB_APP_CLIENT_ID}
-        clientSecret: ${GITHUB_APP_CLIENT_SECRET}
+        clientId: ${AUTH_GITHUB_CLIENT_ID}
+        clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
 
 scaffolder:
   # see https://backstage.io/docs/features/software-templates/configuration for software template options

diff --git a/showcase-docs/getting-started.md b/showcase-docs/getting-started.md
@@ -230,30 +230,30 @@ The easiest and fastest method for getting started: Backstage Showcase app, runn
 
      - There are currently three options for sign on providers within the showcase app. The availability of the sign on providers are determined by the variable set under `auth.environment`.
 
-     - To enable the GitHub and Guest sign on providers, add the following to the config file
+     - To enable the GitHub and Guest sign on providers, add the following to the config file and set `clientId` and `clientSecret` to the appropriate values based on your GitHub OAuth App. See G[itHub Authentication Provider](https://backstage.io/docs/auth/github/provider) documentation for more information and all available configuration options.
 
-     ```yaml
-     auth:
-       environment: development
-       providers:
-         github:
-           development:
-             clientId: ${GITHUB_APP_CLIENT_ID}
-             clientSecret: ${GITHUB_APP_CLIENT_SECRET}
-     ```
+       ```yaml
+       auth:
+         environment: development
+         providers:
+           github:
+             development:
+               clientId: ${AUTH_GITHUB_CLIENT_ID}
+               clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
+       ```
 
      - To enable the oauth2Proxy sign on provider, add the following to the config file. GitHub will still need to be included and configured as it is relied on by the GitHub plugins.
 
-     ```yaml
-     auth:
-       environment: production
-       providers:
-         github:
-           production:
-             clientId: ${GITHUB_APP_CLIENT_ID}
-             clientSecret: ${GITHUB_APP_CLIENT_SECRET}
-         oauth2Proxy: {}
-     ```
+       ```yaml
+       auth:
+         environment: production
+         providers:
+           github:
+             production:
+               clientId: ${AUTH_GITHUB_CLIENT_ID}
+               clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
+           oauth2Proxy: {}
+       ```
 
 4. Run `yarn install` to install the dependencies