Skip to content

docs: add RustFS configuration documentation for S3 storage - #932

Closed
majinghe wants to merge 1 commit into
langgenius:mainfrom
majinghe:feat/add-rustfs-support
Closed

docs: add RustFS configuration documentation for S3 storage#932
majinghe wants to merge 1 commit into
langgenius:mainfrom
majinghe:feat/add-rustfs-support

Conversation

@majinghe

@majinghe majinghe commented Aug 6, 2026

Copy link
Copy Markdown

Description

RustFS is a S3-compatible object storage, and adding RustFS as a documented S3-compatible storage option for Dify self-hosted deployments.

Changes

  1. S3_ENDPOINT description: Added RustFS alongside MinIO as an example of S3-compatible service
  2. Configuration tip: Added a dedicated tip section with RustFS-specific configuration details

RustFS Configuration Details

The documentation includes important notes for RustFS users:

  • S3 API Port: RustFS uses port 9000 for S3 API (not port 9001 which is the web console)
  • Address Style: Must set S3_ADDRESS_STYLE=path for proper bucket addressing
  • Complete Example: Provided a full configuration example

Configuration Example

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

Add RustFS as a supported S3-compatible storage option:

1. Update S3_ENDPOINT description to mention RustFS alongside MinIO
2. Add configuration tip with RustFS-specific settings:
   - S3 API port (9000 vs 9001 console port)
   - S3_ADDRESS_STYLE=path requirement
   - Complete configuration example

RustFS has been verified to work with Dify's S3 storage backend.
@majinghe
majinghe requested a review from RiskeyL as a code owner August 6, 2026 10:48
Copilot AI lite review requested due to automatic review settings August 6, 2026 10:48
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 6, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents RustFS as an S3-compatible storage option for Dify self-hosted deployments by updating the S3 environment variable reference and adding RustFS-specific configuration guidance.

Changes:

  • Updated S3_ENDPOINT description to include RustFS as an example of an S3-compatible service.
  • Added a RustFS-specific <Tip> under the S3 storage accordion with port/addressing-style guidance and a full .env example.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +457 to +461
<Tip>
**RustFS Configuration**

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

@majinghe majinghe changed the title feat: add RustFS configuration documentation for S3 storage docs: add RustFS configuration documentation for S3 storage Aug 6, 2026
@RiskeyL

RiskeyL commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

@majinghe Thanks for the contribution.

The environment variable reference documents Dify's own configuration surface, and we keep vendor-specific setup guidance out of it. The generic S3 variables (S3_ENDPOINT, S3_ADDRESS_STYLE) already apply to any S3-compatible service, and details like which port serves the S3 API belong in the vendor's own documentation.

If RustFS publishes a "use with Dify" guide on its side, the generic variables documented here should be everything it needs. Closing this PR, and thanks again for taking the time.

@RiskeyL RiskeyL closed this Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants