From 97b8c8c8fc6a44bc19ad9850ae0ef8890f66c890 Mon Sep 17 00:00:00 2001
From: Otto Sichert <git@ottosichert.de>
Date: Thu, 18 Nov 2021 17:23:43 +0100
Subject: [PATCH] Ensure all relevant port references are updated and document
 changes

Signed-off-by: Otto Sichert <git@ottosichert.de>
---
 .changeset/pretty-trains-appear.md             | 18 +++++++++++++-----
 packages/create-app/CHANGELOG.md               | 14 +++++++-------
 .../embedded-techdocs-app/app-config.dev.yaml  |  4 ++--
 .../embedded-techdocs-app/src/App.test.tsx     |  4 ++--
 .../techdocs-cli/src/commands/serve/serve.ts   |  2 +-
 .../techdocs-cli/src/lib/PublisherConfig.ts    |  4 ++--
 6 files changed, 27 insertions(+), 19 deletions(-)

diff --git a/.changeset/pretty-trains-appear.md b/.changeset/pretty-trains-appear.md
index 3e3c9e9a5e..9a7b313524 100644
--- a/.changeset/pretty-trains-appear.md
+++ b/.changeset/pretty-trains-appear.md
@@ -1,12 +1,8 @@
 ---
-'example-app': patch
-'example-backend': patch
 '@backstage/backend-common': patch
 '@backstage/cli': patch
 '@backstage/core-app-api': patch
 '@backstage/create-app': patch
-'e2e-test': patch
-'storybook': patch
 '@backstage/techdocs-common': patch
 '@backstage/plugin-auth-backend': patch
 '@backstage/plugin-azure-devops-backend': patch
@@ -23,4 +19,16 @@
 '@backstage/plugin-techdocs-backend': patch
 ---
 
-Change default port of backend from 7000 to 7007
+Change default port of backend from 7000 to 7007.
+
+This is due to the AirPlay Receiver process occupying port 7000 and preventing local Backstage instances on MacOS to start.
+
+You can change the port back to 7000 or any other value by providing an `app-config.yaml` with the following values:
+
+```
+backend:
+  listen: 0.0.0.0:7123
+  baseUrl: http://localhost:7123
+```
+
+More information can be found here: https://backstage.io/docs/conf/writing
diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md
index 6ca70f1223..af1fd58ead 100644
--- a/packages/create-app/CHANGELOG.md
+++ b/packages/create-app/CHANGELOG.md
@@ -1149,9 +1149,9 @@
   // app-config.yaml
 
   backend:
-    baseUrl: http://localhost:7007
+    baseUrl: http://localhost:7000
     listen:
-      port: 7007
+      port: 7000
     database:
       client: sqlite3
       connection: ':memory:'
@@ -2238,9 +2238,9 @@ For more information and the background to this change, see the [composability s
       {
         data: {
           app: { title: 'Test' },
-          backend: { baseUrl: 'http://localhost:7007' },
+          backend: { baseUrl: 'http://localhost:7000' },
           techdocs: {
-            storageUrl: 'http://localhost:7007/api/techdocs/static/docs',
+            storageUrl: 'http://localhost:7000/api/techdocs/static/docs',
           },
         },
         context: 'test',
@@ -3444,12 +3444,12 @@ For more information and the background to this change, see the [composability s
   ```yaml
   app:
     # Should be the same as backend.baseUrl when using the `app-backend` plugin
-    baseUrl: http://localhost:7007
+    baseUrl: http://localhost:7000
 
   backend:
-    baseUrl: http://localhost:7007
+    baseUrl: http://localhost:7000
     listen:
-      port: 7007
+      port: 7000
   ```
 
   In order to load in the new configuration at runtime, the command in the `Dockerfile` at the repo root was changed to the following:
diff --git a/packages/embedded-techdocs-app/app-config.dev.yaml b/packages/embedded-techdocs-app/app-config.dev.yaml
index 2d1bad2808..02d68c940e 100644
--- a/packages/embedded-techdocs-app/app-config.dev.yaml
+++ b/packages/embedded-techdocs-app/app-config.dev.yaml
@@ -5,8 +5,8 @@ app:
   baseUrl: http://localhost:3000
 
 backend:
-  baseUrl: http://localhost:7000
+  baseUrl: http://localhost:7007
 
 techdocs:
   builder: 'external'
-  requestUrl: http://localhost:7000/api
+  requestUrl: http://localhost:7007/api
diff --git a/packages/embedded-techdocs-app/src/App.test.tsx b/packages/embedded-techdocs-app/src/App.test.tsx
index a5a4374976..f177433d95 100644
--- a/packages/embedded-techdocs-app/src/App.test.tsx
+++ b/packages/embedded-techdocs-app/src/App.test.tsx
@@ -26,9 +26,9 @@ describe('App', () => {
         {
           data: {
             app: { title: 'Test' },
-            backend: { baseUrl: 'http://localhost:7000' },
+            backend: { baseUrl: 'http://localhost:7007' },
             techdocs: {
-              storageUrl: 'http://localhost:7000/api/techdocs/static/docs',
+              storageUrl: 'http://localhost:7007/api/techdocs/static/docs',
             },
           },
           context: 'test',
diff --git a/packages/techdocs-cli/src/commands/serve/serve.ts b/packages/techdocs-cli/src/commands/serve/serve.ts
index 1182c850b3..4d71de3e52 100644
--- a/packages/techdocs-cli/src/commands/serve/serve.ts
+++ b/packages/techdocs-cli/src/commands/serve/serve.ts
@@ -36,7 +36,7 @@ export default async function serve(cmd: Command) {
   // a backstage app, we define app.baseUrl in the app-config.yaml.
   // Hence, it is complicated to make this configurable.
   const backstagePort = 3000;
-  const backstageBackendPort = 7000;
+  const backstageBackendPort = 7007;
 
   const mkdocsDockerAddr = `http://0.0.0.0:${cmd.mkdocsPort}`;
   const mkdocsLocalAddr = `http://127.0.0.1:${cmd.mkdocsPort}`;
diff --git a/packages/techdocs-cli/src/lib/PublisherConfig.ts b/packages/techdocs-cli/src/lib/PublisherConfig.ts
index d4779995c0..c18b9ff588 100644
--- a/packages/techdocs-cli/src/lib/PublisherConfig.ts
+++ b/packages/techdocs-cli/src/lib/PublisherConfig.ts
@@ -55,9 +55,9 @@ export class PublisherConfig {
     return new ConfigReader({
       // This backend config is not used at all. Just something needed a create a mock discovery instance.
       backend: {
-        baseUrl: 'http://localhost:7000',
+        baseUrl: 'http://localhost:7007',
         listen: {
-          port: 7000,
+          port: 7007,
         },
       },
       techdocs: {