Guide: use Garage for local S3 storage, add initS3CompatibleStorage - #2770
Draft
amitaibu wants to merge 2 commits into
Draft
Guide: use Garage for local S3 storage, add initS3CompatibleStorage#2770amitaibu wants to merge 2 commits into
amitaibu wants to merge 2 commits into
Conversation
The MinIO server was archived and no longer receives updates, so the file storage guide now sets up Garage via devenv's `services.garage` for local development. `initMinioStorage` is unchanged, it's an S3 client and works against any S3 compatible server. Verified the devenv snippet against garage 2.3.0: layout apply, key import, bucket allow, and an S3 PUT/GET with the imported credentials. Refs #2769 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
amitaibu
marked this pull request as draft
August 6, 2026 18:27
`initMinioStorage` was never MinIO specific, it's an S3 client that talks to any S3 compatible server. Rename it accordingly and read credentials from the standard `AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY` env vars that the AWS CLI and the rest of the S3 tooling ecosystem use. Fully backwards compatible: `initMinioStorage` stays as a deprecated alias, and `MINIO_ACCESS_KEY` / `MINIO_SECRET_KEY` are still read first. Refs #2769 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
amitaibu
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #2769 (docs part).
The file storage guide told users to run MinIO for local development. That server is archived now, so the guide sets up Garage instead via devenv's
services.garage.While in there:
initMinioStorageandMINIO_ACCESS_KEYwere never MinIO-specific — it's an S3 client that talks to any S3-compatible server. So:initS3CompatibleStorage, withinitMinioStoragekept as a{-# DEPRECATED #-}alias.AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY, the names the AWS CLI and the rest of the S3 tooling use.MINIO_ACCESS_KEY/MINIO_SECRET_KEYare still tried first, so nothing existing breaks.Files:
ihp/IHP/FileStorage/Config.hs— new function + deprecated aliasGuide/file-storage.markdown— Minio section → Garage sectionGuide/config.markdown— "Minio Storage" → "S3 Compatible Storage"Verified
IHP.FileStorage.Configloads in ghci (Ok, 26 modules loaded), and the devenv snippet end-to-end against garage 2.3.0: layout apply,key import,bucket allow, then an S3 PUT + GET with the imported credentials (both 200). Thekey info || key importguard is there because a bare re-import fails withKeyAlreadyExistson the seconddevenv up.The
minio-hsclient itself is still stale (no release since 1.7.0, jailbroken inNixSupport/overlay.nix) — that's the other half of #2769 and left out of this PR.🤖 Generated with Claude Code