Skip to content

docs: document S3_ADDRESS_STYLE variable and add Tigris example#734

Merged
RiskeyL merged 3 commits into
langgenius:mainfrom
davidmyriel:myriel/tigris-data
Apr 9, 2026
Merged

docs: document S3_ADDRESS_STYLE variable and add Tigris example#734
RiskeyL merged 3 commits into
langgenius:mainfrom
davidmyriel:myriel/tigris-data

Conversation

@davidmyriel

Copy link
Copy Markdown
Contributor

Summary

  • Document the S3_ADDRESS_STYLE environment variable in the S3 storage section. This variable is supported in code (api/configs/middleware/storage/amazon_s3_storage_config.py, line 37) but was missing from the docs. It controls whether boto3 uses path-style or virtual-hosted-style S3 requests.
  • Add a Tigris configuration example showing how to use Tigris as an S3-compatible storage backend with the existing s3 storage type.

Changes

  • en/self-host/configuration/environments.mdx: Added S3_ADDRESS_STYLE row to the S3 variable table. Added Tigris to the S3_ENDPOINT description alongside MinIO. Added a short Tigris example block with env var values.

Notes

  • No new storage type — Tigris uses the existing s3 backend.
  • All variable names and defaults verified against api/configs/middleware/storage/amazon_s3_storage_config.py and api/extensions/storage/aws_s3_storage.py.
  • English docs only; translations sync automatically per repo conventions.

@davidmyriel davidmyriel requested a review from RiskeyL as a code owner April 8, 2026 12:19
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Apr 8, 2026
@dosubot dosubot Bot added size:XS This PR changes 0-9 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels Apr 9, 2026
@RiskeyL

RiskeyL commented Apr 9, 2026

Copy link
Copy Markdown
Contributor

Hi @davidmyriel, thanks for this PR! Documenting S3_ADDRESS_STYLE fills a real gap. We've also coordinated with the dev team to get it added to .env.example and docker-compose.yaml (langgenius/dify#34826), so it's now fully discoverable for self-hosted users.

We made a few adjustments to align with our documentation standards:

Kept:

  • The S3_ADDRESS_STYLE row in the table — this is the core value of the PR.

Changed:

  • Rewrote the S3_ADDRESS_STYLE description to explain what path and virtual actually mean (bucket name in the URL path vs as a subdomain), and added a note that it only applies when S3_USE_AWS_MANAGED_IAM is false.
  • Reverted S3_ENDPOINT and S3_REGION to their original descriptions — our env var reference keeps rows provider-neutral so the table stays clean as more S3-compatible services are added.

Removed:

  • The Tigris example block. Our env var docs describe what each variable does and what values it accepts — that's enough for users to configure any S3-compatible service. Provider-specific setup guides are better maintained by the respective provider communities, where they can stay up to date as those services evolve.

Appreciate the contribution!

@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Apr 9, 2026
@RiskeyL RiskeyL merged commit fe8be9d into langgenius:main Apr 9, 2026
3 checks passed
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 lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants