@alepha/bucket-s3 0.14.4 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -40
- package/dist/index.d.ts +43 -2054
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -26,46 +26,18 @@ For more details, see the [Providers documentation](https://feunard.github.io/al
|
|
|
26
26
|
|
|
27
27
|
#### S3FileStorageProvider
|
|
28
28
|
|
|
29
|
-
Custom S3 endpoint URL for S3-compatible services.
|
|
30
|
-
|
|
31
|
-
Examples:
|
|
32
|
-
- Cloudflare R2: https://<account-id>.r2.cloudflarestorage.com
|
|
33
|
-
- MinIO: http://localhost:9000
|
|
34
|
-
- DigitalOcean Spaces: https://<region>.digitaloceanspaces.com
|
|
35
|
-
|
|
36
|
-
Leave empty for AWS S3.
|
|
37
|
-
/
|
|
38
|
-
S3_ENDPOINT: t.optional(t.string()),
|
|
39
|
-
|
|
40
|
-
/**
|
|
41
|
-
AWS region or "auto" for R2.
|
|
42
|
-
|
|
43
|
-
@default "us-east-1"
|
|
44
|
-
/
|
|
45
|
-
S3_REGION: t.optional(t.string()),
|
|
46
|
-
|
|
47
|
-
/**
|
|
48
|
-
Access key ID for S3 authentication.
|
|
49
|
-
/
|
|
50
|
-
S3_ACCESS_KEY_ID: t.string(),
|
|
51
|
-
|
|
52
|
-
/**
|
|
53
|
-
Secret access key for S3 authentication.
|
|
54
|
-
/
|
|
55
|
-
S3_SECRET_ACCESS_KEY: t.string(),
|
|
56
|
-
|
|
57
|
-
/**
|
|
58
|
-
Force path-style URLs (required for MinIO and some S3-compatible services).
|
|
59
|
-
Set to "true" to enable.
|
|
60
|
-
/
|
|
61
|
-
S3_FORCE_PATH_STYLE: t.optional(t.string()),
|
|
62
|
-
});
|
|
63
|
-
|
|
64
|
-
declare module "alepha" {
|
|
65
|
-
interface Env extends Partial<Static<typeof envSchema>> {}
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
29
|
S3-compatible storage implementation of File Storage Provider.
|
|
70
30
|
|
|
71
31
|
Works with AWS S3, Cloudflare R2, MinIO, DigitalOcean Spaces, and other S3-compatible services.
|
|
32
|
+
|
|
33
|
+
### Environment Variables
|
|
34
|
+
|
|
35
|
+
Environment variables used to configure this package.
|
|
36
|
+
|
|
37
|
+
| Variable | Type | Default | Description |
|
|
38
|
+
|----------|------|---------|-------------|
|
|
39
|
+
| `S3_ACCESS_KEY_ID` | string | **Required** | |
|
|
40
|
+
| `S3_ENDPOINT` | string | - | |
|
|
41
|
+
| `S3_FORCE_PATH_STYLE` | string | - | |
|
|
42
|
+
| `S3_REGION` | string | - | |
|
|
43
|
+
| `S3_SECRET_ACCESS_KEY` | string | **Required** | |
|