feat: support minio

.env.example

@@ -16,6 +16,14 @@ S3_ACCESS_KEY=
 S3_SECRET_KEY=
 S3_REGION=
 S3_ENDPOINT=
+# MINIO (Use along with AWS S3 Storage Provider)
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION=
+S3_ACCESS_KEY=
+S3_SECRET_KEY=
+S3_REGION=
+S3_ENDPOINT=
 # Google Cloud Storage Provider
 GCS_PROJECT_ID=
 GCS_CLIENT_EMAIL=

docs/supported-storage-providers.md

@@ -73,9 +73,18 @@ DigitalOcean Spaces is an S3-compatible object storage that this project also su
   GCS_CLIENT_EMAIL=
   GCS_PRIVATE_KEY=
   ```
-  
+
 ##  Azure Blob Storage
 
 1. Create a new Blob Storage.
 2. On "Security + networking" tab, copy one of `Connection string` on "Access keys" blade.
-3. Set `ABS_CONNECTION_STRING` to the connection string.
+3. Set `ABS_CONNECTION_STRING` to the connection string.
+
+## Minio
+1. Create Access key
+2. Fill in the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables based on the access key you created.
+3. Create bucket
+4. Set `STORAGE_PATH` to the name of the bucket you created.
+5. Set `AWS_REGION` (can leave blank `S3_REGION=` for none).
+6. Set `STORAGE_PROVIDER` to `minio`.
+7. Set `S3_ENDPOINT` to Minio url (ie `http://127.0.0.1:9000`)

src/env.ts

@@ -15,6 +15,7 @@ export const STORAGE_PROVIDERS = {
   s3: 's3',
   GOOGLE_CLOUD_STORAGE: 'google-cloud-storage',
   AZURE_BLOB_STORAGE: 'azure-blob-storage',
+  MINIO: 'minio',
 } as const
 export type STORAGE_PROVIDERS =
   typeof STORAGE_PROVIDERS[keyof typeof STORAGE_PROVIDERS]

src/plugins/remote-cache/storage/index.ts

@@ -63,6 +63,20 @@ function createStorageLocation<Provider extends STORAGE_PROVIDERS>(
         providerOptions as S3Options
       return createS3({ accessKey, secretKey, bucket: path, region, endpoint })
     }
+    case STORAGE_PROVIDERS.MINIO: {
+      const { accessKey, secretKey, region, endpoint } =
+        providerOptions as S3Options
+      return createS3({
+        accessKey,
+        secretKey,
+        bucket: path,
+        region,
+        endpoint,
+        s3OptionsPassthrough: {
+          s3ForcePathStyle: true,
+        },
+      })
+    }
     case STORAGE_PROVIDERS.GOOGLE_CLOUD_STORAGE: {
       const { clientEmail, privateKey, projectId } =
         providerOptions as GoogleCloudStorageOptions

src/plugins/remote-cache/storage/s3.ts

@@ -1,4 +1,5 @@
 import aws from 'aws-sdk'
+import type { S3 } from 'aws-sdk'
 import s3 from 's3-blob-store'
 
 export interface S3Options {
@@ -7,6 +8,7 @@ export interface S3Options {
   region?: string
   endpoint?: string
   bucket: string
+  s3OptionsPassthrough?: S3.ClientConfiguration
 }
 
 // AWS_ envs are default for aws-sdk
@@ -16,6 +18,7 @@ export function createS3({
   bucket,
   region = process.env.AWS_REGION || process.env.S3_REGION,
   endpoint,
+  s3OptionsPassthrough = {},
 }: S3Options) {
   const client = new aws.S3({
     ...(accessKey && secretKey
@@ -32,6 +35,7 @@ export function createS3({
     ...(process.env.NODE_ENV === 'test'
       ? { sslEnabled: false, s3ForcePathStyle: true }
       : {}),
+    ...s3OptionsPassthrough,
   })
 
   const location = s3({