moved secrets to backend schema

README.md

@@ -66,14 +66,15 @@ For more than 15 users you need to get a license from [Port](https://backstage-p
 
    - In Port, on the top right, click on the three dots and select **Credentials**
    - Generate API credentials (Client ID and Client Secret)
-   - Add these credentials to your Backstage's `app-config.yaml`:
+   - Add these credentials to your Backstage's `app-config.yaml` under the `backend`:
      ```yaml
-     port:
-       api:
-         baseUrl: https://api.getport.io/
-         auth:
-           clientId: YOUR_CLIENT_ID
-           clientSecret: YOUR_CLIENT_SECRET
+     backend:
+       port:
+         api:
+           baseUrl: https://api.getport.io/
+           auth:
+             clientId: YOUR_CLIENT_ID
+             clientSecret: YOUR_CLIENT_SECRET
      ```
    - [Find your Port credentials](https://docs.getport.io/build-your-software-catalog/custom-integration/api/#find-your-port-credentials)
 

backstage-plugins/plugins/backend-plugin/app-config.yaml

@@ -6,13 +6,10 @@ backend:
   baseUrl: http://localhost:7007
   listen:
     port: 7007
-  auth:
-    # For testing purposes, we're disabling the default auth policy
-    dangerouslyDisableDefaultAuthPolicy: true
 
-port:
-  api:
-    baseUrl: https://api.getport.io/
-    auth:
-      clientId:
-      clientSecret:
+  port:
+    api:
+      baseUrl: https://api.getport.io/
+      auth:
+        clientId:
+        clientSecret:

backstage-plugins/plugins/backend-plugin/config.d.ts

@@ -0,0 +1,13 @@
+export interface Config {
+  backend: {
+    port: {
+      api: {
+        baseUrl: string;
+        auth: {
+          clientId: string;
+          clientSecret: string;
+        };
+      };
+    };
+  };
+}

backstage-plugins/plugins/backend-plugin/package.json

@@ -47,6 +47,8 @@
     "supertest": "^6.2.4"
   },
   "files": [
-    "dist"
-  ]
+    "dist",
+    "config.d.ts"
+  ],
+  "configSchema": "config.d.ts"
 }

backstage-plugins/plugins/backend-plugin/src/service/router.ts

@@ -33,12 +33,11 @@ function isTokenExpired(token: string): boolean {
 
 export function createAuthMiddleware(options: {
   logger: LoggerService;
-  config: RootConfigService;
+  baseUrl: string;
+  clientId: string;
+  clientSecret: string;
 }) {
-  const { logger, config } = options;
-  const baseUrl = config.getString('port.api.baseUrl');
-  const clientId = config.getString('port.api.auth.clientId');
-  const clientSecret = config.getString('port.api.auth.clientSecret');
+  const { logger, baseUrl, clientId, clientSecret } = options;
 
   const router = Router();
   logger.info('Creating auth middleware');
@@ -64,10 +63,9 @@ export function createAuthMiddleware(options: {
 
 export function createPortProxyMiddleware(options: {
   logger: LoggerService;
-  config: RootConfigService;
+  baseUrl: string;
 }) {
-  const { logger, config } = options;
-  const baseUrl = config.getString('port.api.baseUrl');
+  const { logger, baseUrl } = options;
 
   const target = getBaseUrl(baseUrl);
 
@@ -85,9 +83,10 @@ export async function createRouter(
   options: RouterOptions,
 ): Promise<express.Handler> {
   const { logger, config } = options;
-  const baseUrl = config.getString('port.api.baseUrl');
-  const clientId = config.getString('port.api.auth.clientId');
-  const clientSecret = config.getString('port.api.auth.clientSecret');
+  const portConfig = config.getConfig('backend.port');
+  const baseUrl = portConfig.getString('api.baseUrl');
+  const clientId = portConfig.getString('api.auth.clientId');
+  const clientSecret = portConfig.getString('api.auth.clientSecret');
 
   const router = Router();
   router.use(express.json());
@@ -112,8 +111,8 @@ export async function createRouter(
 
   router.use(
     '/proxy',
-    createAuthMiddleware(options),
-    createPortProxyMiddleware(options),
+    createAuthMiddleware({ logger, baseUrl, clientId, clientSecret }),
+    createPortProxyMiddleware({ logger, baseUrl }),
   );
   return router;
 }

docs/site/docs/getting-started.md

@@ -53,15 +53,16 @@ and then add the link to the NavBar, in the file: `packages/app/src/components/R
 
 1. In Port, on the top right, click on the `...` (three dots) and select **Credentials**.
 2. Generate API credentials (Client ID and Client Secret)
-3. Add these credentials to your Backstage's `app-config.yaml`:
+3. Add these credentials to your Backstage's `app-config.yaml` under the `backend`:
 
    ```yaml
-   port:
-     api:
-       baseUrl: https://api.getport.io/
-       auth:
-         clientId: YOUR_CLIENT_ID
-         clientSecret: YOUR_CLIENT_SECRET
+   backend:
+     port:
+       api:
+         baseUrl: https://api.getport.io/
+         auth:
+           clientId: YOUR_CLIENT_ID
+           clientSecret: YOUR_CLIENT_SECRET
    ```
 
 <br />

docs/site/docs/installation.md

@@ -44,15 +44,16 @@ and then add the link to the NavBar, in the file: `packages/app/src/components/R
 
 1. In Port, on the top right, click on the `...` (three dots) and select **Credentials**.
 2. Generate API credentials (Client ID and Client Secret)
-3. Add these credentials to your Backstage's `app-config.yaml`:
+3. Add these credentials to your Backstage's `app-config.yaml` under the `backend`:
 
    ```yaml
-   port:
-     api:
-       baseUrl: https://api.getport.io/
-       auth:
-         clientId: YOUR_CLIENT_ID
-         clientSecret: YOUR_CLIENT_SECRET
+   backend:
+     port:
+       api:
+         baseUrl: https://api.getport.io/
+         auth:
+           clientId: YOUR_CLIENT_ID
+           clientSecret: YOUR_CLIENT_SECRET
    ```
 
 <br />