marten_s3

Version, currently 0.2.02 versions

github.com/martenframework/marten-s3

๐Ÿ” S3 file storage backend for the Marten framework

3 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  marten_s3:
    github: martenframework/marten-s3
    version: ~> 0.2.0

Then run:

shards install

shard.yml

Crystal
no constraint declared

Dependencies

Runtime Dependencies

  • marten*github: martenframework/marten
  • awscr-s3~> 0.10.0github: taylorfinnell/awscr-s3

Development Dependencies

  • ameba*github: crystal-ameba/ameba, branch: masterdev
  • sqlite3*github: crystal-lang/crystal-sqlite3dev

README

Marten S3

GitHub Release Marten Turbo Specs QA

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
)