Skip to content

Conversation

@corylanou
Copy link
Collaborator

Summary

This PR documents the new custom S3 endpoint support feature that allows users to specify S3-compatible storage endpoints directly from the command line using URL query parameters.

Key Changes

  • New Documentation Section: Added comprehensive "S3-Compatible Storage Providers" section to the S3 replication guide
  • URL Format Documentation: Documented the query parameter syntax for custom endpoints
  • Provider Examples: Added working examples for:
    • MinIO (self-hosted)
    • Tigris (Fly.io)
    • Wasabi (cloud storage)
    • Self-hosted with custom certificates
  • Query Parameters Reference: Complete documentation of endpoint, region, forcePathStyle, and skipVerify parameters
  • Configuration Alternatives: Showed both command-line and config file approaches
  • Backward Compatibility: Emphasized that existing S3 URLs continue to work unchanged
  • Security Guidance: Included appropriate warnings for skipVerify usage

Test Plan

  • Hugo build completes successfully without errors
  • Markdown linting passes (fixed pre-existing link fragment issue)
  • Documentation follows existing patterns and tone
  • All examples are properly formatted and consistent
  • Security warnings are appropriately highlighted

Related Issues

Closes #80

This implements the documentation requirements for the custom S3 endpoint feature that was added in benbjohnson/litestream#731.

🤖 Generated with Claude Code

Add comprehensive documentation for the new custom S3 endpoint feature that
allows users to specify S3-compatible storage endpoints directly from the
command line using URL query parameters.

Changes:
- Add new "S3-Compatible Storage Providers" section with URL format documentation
- Document query parameters: endpoint, region, forcePathStyle, skipVerify
- Add provider examples for MinIO, Tigris, Wasabi, and self-hosted services
- Include configuration file alternatives and backward compatibility notes
- Fix existing link fragment issue for restrictive IAM policies

This addresses issue #80 and documents the feature implemented in PR #731.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
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.

Document custom S3 endpoint support via URL query parameters

2 participants