Add possibility to use path style discovery on S3 tech docs. Enables the possibility to support S3-like buckets that rely on path style API like Localstack.

Signed-off-by: Jussi Hallila <jussi@hallila.com>

.changeset/tricky-yaks-melt.md

@@ -0,0 +1,6 @@
+---
+'@backstage/techdocs-common': patch
+---
+
+Adding optional config to enable S3-like API for tech-docs using s3ForcePathStyle option.
+This allows providers like LocalStack, Minio and Wasabi (+possibly others) to be used to host tech docs.

.github/styles/vocab.txt

@@ -41,8 +41,10 @@ Kaewkasi
 Knex
 Leasot
 Lerna
+LocalStack
 Luxon
 Minikube
+Minio
 Mkdocs
 Monorepo
 Namespaces

docs/features/techdocs/configuration.md

@@ -78,6 +78,11 @@ techdocs:
       # https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property
       endpoint: ${AWS_ENDPOINT}
 
+      # (Optional) Whether to use path style URLs when communicating with S3.
+      # Defaults to false.
+      # This allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used to host tech docs.
+      s3ForcePathStyle: false
+
     # Required when techdocs.publisher.type is set to 'azureBlobStorage'. Skip otherwise.
 
     azureBlobStorage:

packages/techdocs-common/src/stages/publish/awsS3.ts

@@ -80,10 +80,17 @@ export class AwsS3Publish implements PublisherBase {
       'techdocs.publisher.awsS3.endpoint',
     );
 
+    // AWS forcePathStyle is an optional config. If missing, it defaults to false. Needs to be enabled for cases
+    // where endpoint url points to locally hosted S3 compatible storage like Localstack
+    const s3ForcePathStyle = config.getOptionalBoolean(
+      'techdocs.publisher.awsS3.s3ForcePathStyle',
+    );
+
     const storageClient = new aws.S3({
       credentials,
       ...(region && { region }),
       ...(endpoint && { endpoint }),
+      ...(s3ForcePathStyle && { s3ForcePathStyle }),
     });
 
     return new AwsS3Publish(storageClient, bucketName, logger);

plugins/techdocs-backend/config.d.ts

@@ -90,6 +90,13 @@ export interface Config {
              * @visibility secret
              */
             endpoint?: string;
+            /**
+             * (Optional) Whether to use path style URLs when communicating with S3.
+             * Defaults to false.
+             * This allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used to host tech docs.
+             * @visibility backend
+             */
+            endpoint?: string;
           };
         }
       | {