Skip to content

docs: clarify S3-compatible endpoint configuration for backups#469

Open
goanpeca wants to merge 1 commit into
weaviate:mainfrom
goanpeca:docs-s3-compatible-backup-endpoints
Open

docs: clarify S3-compatible endpoint configuration for backups#469
goanpeca wants to merge 1 commit into
weaviate:mainfrom
goanpeca:docs-s3-compatible-backup-endpoints

Conversation

@goanpeca

@goanpeca goanpeca commented Jul 8, 2026

Copy link
Copy Markdown

Summary

The backup-s3 module already works with Amazon S3 and any S3-compatible object store (it builds its client from BACKUP_S3_ENDPOINT), but the backups page does not spell out how to point it at a non-AWS endpoint or how its AWS-named credentials apply to compatible backends. This adds that guidance. Docs only, no code or behavior changes.

What changed

One file, docs/deploy/configuration/backups.md:

  • Broadened the S3 intro line to lead with Amazon S3 and name a few S3-compatible examples (Backblaze B2, Cloudflare R2, MinIO).
  • Updated the S3 configuration table to clarify that BACKUP_S3_ENDPOINT accepts a host with an optional port, must not include an http:// or https:// scheme, and uses BACKUP_S3_USE_SSL for TLS.
  • Reworked the S3 authentication text so AWS IAM/ARN stays AWS-specific while access-key credentials are documented as usable with S3-compatible backends.
  • Added a short "S3-compatible endpoints" subsection with a copy-pasteable env example using a placeholder endpoint, optional port guidance, and optional AWS_REGION guidance.

Notes

Examples use a placeholder endpoint and no provider is singled out.

@orca-security-eu orca-security-eu Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@goanpeca goanpeca marked this pull request as ready for review July 8, 2026 16:55
Copilot AI review requested due to automatic review settings July 8, 2026 16:55

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

This PR updates the backups configuration documentation to more explicitly explain how to use the backup-s3 module with non-AWS, S3-compatible object stores by clarifying BACKUP_S3_ENDPOINT usage and related environment variables.

Changes:

  • Expanded the S3 section intro to explicitly mention Amazon S3 plus several S3-compatible providers.
  • Added an “S3-compatible endpoints” subsection with guidance and a copy/paste environment example.

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

Comment thread docs/deploy/configuration/backups.md Outdated
Comment thread docs/deploy/configuration/backups.md Outdated
Comment thread docs/deploy/configuration/backups.md Outdated
@weaviate-git-bot

Copy link
Copy Markdown

To avoid any confusion in the future about your contribution to Weaviate, we work with a Contributor License Agreement. If you agree, you can simply add a comment to this PR that you agree with the CLA so that we can merge.

beep boop - the Weaviate bot 👋🤖

PS:
Are you already a member of the Weaviate Forum?

@goanpeca

goanpeca commented Jul 8, 2026

Copy link
Copy Markdown
Author

I agree with the CLA

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread docs/deploy/configuration/backups.md Outdated

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread docs/deploy/configuration/backups.md Outdated
Comment thread docs/deploy/configuration/backups.md Outdated

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@goanpeca goanpeca force-pushed the docs-s3-compatible-backup-endpoints branch from 2607793 to cecf15c Compare July 8, 2026 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants