mirror of
https://github.com/LibreChat-AI/librechat.ai.git
synced 2026-03-27 02:38:32 +07:00
feat: add AWS_FORCE_PATH_STYLE option to dotenv and S3 configuration documentation
- Introduced the `AWS_FORCE_PATH_STYLE` boolean option in the dotenv configuration, specifying its use for S3-compatible providers that require path-style URLs. - Updated S3 configuration documentation to clarify the necessity of this option for services like MinIO and Backblaze B2, while noting it is not needed for AWS S3.
This commit is contained in:
@@ -91,13 +91,15 @@ AWS_SECRET_ACCESS_KEY=your_secret_access_key
|
||||
AWS_REGION=your_selected_region
|
||||
AWS_BUCKET_NAME=your_bucket_name
|
||||
AWS_ENDPOINT_URL=your_endpoint_url
|
||||
# AWS_FORCE_PATH_STYLE=false
|
||||
```
|
||||
|
||||
- **AWS_ACCESS_KEY_ID:** Your IAM user's access key.
|
||||
- **AWS_SECRET_ACCESS_KEY:** Your IAM user's secret key.
|
||||
- **AWS_REGION:** The AWS region where your S3 bucket is located.
|
||||
- **AWS_BUCKET_NAME:** The name of the S3 bucket you created.
|
||||
- **AWS_ENDPOINT_URL:** (Optional) The custom AWS endpoint URL
|
||||
- **AWS_ENDPOINT_URL:** (Optional) The custom AWS endpoint URL. Required for S3-compatible services such as MinIO, Cloudflare R2, Hetzner Object Storage, and Backblaze B2.
|
||||
- **AWS_FORCE_PATH_STYLE:** (Optional) Set to `true` for providers that require path-style URLs (`endpoint/bucket/key`) rather than virtual-hosted-style (`bucket.endpoint/key`). Required for Hetzner Object Storage, MinIO, and similar providers whose SSL certificates don't cover bucket subdomains. Not needed for AWS S3 or Cloudflare R2. Default: `false`.
|
||||
|
||||
If you are using **IRSA** on Kubernetes, you do **not** need to set `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` in your environment. The AWS SDK will automatically obtain temporary credentials via the service account assigned to your pod. Ensure that `AWS_REGION` and `AWS_BUCKET_NAME` are still provided.
|
||||
|
||||
|
||||
@@ -1298,6 +1298,7 @@ If you are using S3 as your file storage strategy, make sure to set the `file_st
|
||||
['AWS_REGION', 'string', 'The AWS region where your S3 bucket is located.', 'AWS_REGION=us-east-1'],
|
||||
['AWS_BUCKET_NAME', 'string', 'The name of the S3 bucket for file storage.', 'AWS_BUCKET_NAME=your_bucket_name'],
|
||||
['AWS_ENDPOINT_URL', 'string', 'Custom AWS endpoint URL (optional). For S3-compatible services.', '# AWS_ENDPOINT_URL='],
|
||||
['AWS_FORCE_PATH_STYLE', 'boolean', 'Set to true for S3-compatible providers that require path-style URLs (e.g. MinIO, Hetzner, Backblaze B2). Not needed for AWS S3. Default: false.', '# AWS_FORCE_PATH_STYLE=false'],
|
||||
]}
|
||||
/>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user