Skip to content

docs: add RustFS configuration documentation for S3 storage #932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
majinghe wants to merge 1 commit into from
Closed

docs: add RustFS configuration documentation for S3 storage #932

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion en/self-host/deploy/configuration/environments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,14 +446,34 @@ For all available schemes and their configuration options, see the [OpenDAL serv

| Variable | Default | Description |
|---|---|---|
| `S3_ENDPOINT` | (empty) | S3 endpoint address. Required for non-AWS S3-compatible services (MinIO, etc.). |
| `S3_ENDPOINT` | (empty) | S3 endpoint address. Required for non-AWS S3-compatible services (MinIO, RustFS, etc.). |
| `S3_REGION` | `us-east-1` | S3 region. |
| `S3_BUCKET_NAME` | `difyai` | S3 bucket name. |
| `S3_ACCESS_KEY` | (empty) | S3 Access Key. Not needed when using IAM roles. |
| `S3_SECRET_KEY` | (empty) | S3 Secret Key. Not needed when using IAM roles. |
| `S3_ADDRESS_STYLE` | `auto` | S3 addressing style: `auto`, `path`, or `virtual`. Controls whether bucket names appear in the URL path (`path`) or as a subdomain (`virtual`). Only applies when `S3_USE_AWS_MANAGED_IAM` is `false`. |
| `S3_USE_AWS_MANAGED_IAM` | `false` | Use AWS IAM roles (EC2 instance profile, ECS task role) instead of explicit access key/secret key. When enabled, credentials are auto-discovered from the instance metadata. |

<Tip>
**RustFS Configuration**

When using [RustFS](https://rustfs.com/) as your S3-compatible storage:

Comment on lines +457 to +461
- Use port **9000** for the S3 API endpoint (not port 9001, which is the web console)
- Set `S3_ADDRESS_STYLE` to `path` for proper bucket addressing
- Example: `S3_ENDPOINT=http://your-rustfs-server:9000`

```bash
STORAGE_TYPE=s3
S3_ENDPOINT=http://your-rustfs-server:9000
S3_REGION=us-east-1
S3_BUCKET_NAME=dify
S3_ACCESS_KEY=your-access-key
S3_SECRET_KEY=your-secret-key
S3_ADDRESS_STYLE=path
```
</Tip>

</Accordion>

<Accordion title="Azure Blob">
Expand Down