TechDocs/AWS: Enable authentication using env variables and ~/.aws/config shared file

If authentication secrets are provided in app-config.yaml, it will be used. If not, environment variables AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_REGION will be used. If not present, ~/.aws/config will be used to read the configs. https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-environment.html https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-region.html
2021-01-12 11:41:00 +01:00
parent 1c7771871e
commit 16b73697a3
3 changed files with 58 additions and 28 deletions
@@ -66,15 +66,22 @@ techdocs:
    # Required when techdocs.publisher.type is set to 'awsS3'. Skip otherwise.

    awsS3:
-      # An API key is required to write to a storage bucket.
+      # (Required) AWS S3 Bucket Name
+      bucketName: 'techdocs-storage'
+
+      # (Optional) An API key is required to write to a storage bucket.
+      # If not set, environment variables or aws config file will be used to authenticate.
+      # https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-environment.html
+      # https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html
      credentials:
        accessKeyId:
          $env: TECHDOCS_AWSS3_ACCESS_KEY_ID_CREDENTIAL
        secretAccessKey:
          $env: TECHDOCS_AWSS3_SECRET_ACCESS_KEY_CREDENTIAL
-      region:
-        $env: AWSS3_REGION

-      # AWS S3 Bucket Name
-      bucketName: 'techdocs-storage'
+      # (Optional) AWS Region of the bucket.
+      # If not set, AWS_REGION environment variable or aws config file will be used.
+      # https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/setting-region.html
+      region:
+        $env: AWS_REGION
 ```