Skip to content

Add setup instructions for minio#3981

Open
Iron-56 wants to merge 2 commits intoprocessing:developfrom
Iron-56:docs-minio-setup
Open

Add setup instructions for minio#3981
Iron-56 wants to merge 2 commits intoprocessing:developfrom
Iron-56:docs-minio-setup

Conversation

@Iron-56
Copy link
Contributor

@Iron-56 Iron-56 commented Mar 8, 2026

Issue:

Fixes #3975
Adds documentation for minio setup

Changes:

Adds a doc for minio setup and adds minio folder in gitignore

I have verified that this pull request:

  • has no linting errors (npm run lint)
  • has no test errors (npm run test)
  • has no typecheck errors (npm run typecheck)
  • is from a uniquely-named feature branch and is up to date with the develop branch.
  • is descriptively named and links to an issue number, i.e. Fixes #123
  • meets the standards outlined in the accessibility guidelines

- **[Option 1: MinIO (Local Development)](#minio-local-development)** - Recommended for local development
- **[Option 2: AWS S3 (Production)](#aws-s3-production)** - For production environments

## MinIO (Local Development)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for raising this!

I'm wondering could we maybe switch the order of the options so that the AWS S3 one is first and the MinIO is second? I think it would be great to encourage users to try to get as close to the setup we have as much as possible, while the MinIO option could be present for users who would like to explore a different option.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm also a little hesitant to recommend MinIO as the primary method for local development, OS type, since at the moment we only have docs for Linux. Maybe we could rephrase this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah sure we can switch the order of aws s3 and minio since it would be more relevant, also minio actually does have docs and download for windows so we could either give the docs link to setup minio in windows mention or explicitly say the setup for windows


## MinIO (Local Development)

MinIO is an S3-compatible object storage server that can run locally, making it ideal for development without needing AWS credentials or incurring cloud storage costs.
Copy link
Collaborator

Choose a reason for hiding this comment

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

For the section regarding cloud storage costs, I believe that creating an AWS account and S3 bucket is free and does not require any additional costs, but I might need to double check!

@raclim
Copy link
Collaborator

raclim commented Mar 12, 2026

Thanks for working on this! I added in a few notes on option order and recommendation, but I think overall this looks great!

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.

Add minio setup instructions

2 participants