This README is the one indexed from the repository at its latest ref, not from the tag for this version.

Marten S3

Marten S3 provides a file store implementation to interact with S3 storages

Installation

Simply add the following entry to your project's shard.yml:

dependencies:
  marten_s3:
    github: martenframework/marten-s3

And run shards install afterward.

First, add the following requirement to your project's src/project.cr file:

require "marten_s3"

Afterwards add it to your project applications

config.installed_apps = [
  # …
  MartenS3::App
]

Finally you can configure the storage

config.media_files.storage = MartenS3::Store.new(
  region: "your-region",
  bucket: "bucket-name",
  access_key: "s3_access_key",
  secret_key: "s3_secret_key",
  endpoint: "custom_endpoint", # optional – required only for non-AWS S3-compatible services
  force_path_style: true, # required for most S3-compatible providers (e.g. MinIO, Wasabi); not needed for AWS
)