behinddesign / craft-object-storage
A Craft 5 plugin that integrates with most S3 compatible Object Storage. Includes custom host / path or subdomain connection types
Installs: 48
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 0
Forks: 3
Open Issues: 1
Type:craft-plugin
Requires
- php: ^8.0.2
- craftcms/cms: ^4.0.0|^5.0.0
- craftcms/flysystem: ^1.0.0|^2.0.0
- league/flysystem-aws-s3-v3: ^3.0.0
- symfony/console: ^6.0|^7.0
Requires (Dev)
- craftcms/phpstan: dev-main
- craftcms/rector: dev-main
README
This plugin provides a S3 (Object) storage integration for Craft CMS.
- Supports path style S3 and subdomain style S3.
- Visibility can also be set independently per filesystem.
Requirements
- PHP 8.0
- Craft 5.0
Installation
To install the plugin.
Install the plugin via composer
composer require behinddesign/craft-object-storage
Update your local .env file (Optional, set these during configuration of Filesystem)
OBJECT_STORAGE_BUCKET="my-bucket"
OBJECT_STORAGE_HOST="my-bucket.my.s3.host.com"
OBJECT_STORAGE_HOST_TYPE="subdomain"
OBJECT_STORAGE_VISIBILITY="private"
OBJECT_STORAGE_MAKE_UPLOADS_PUBLIC="true"
OBJECT_STORAGE_REGION="eu-west-1"
OBJECT_STORAGE_ACCESS_KEY="accesskey"
OBJECT_STORAGE_SECRET_KEY="secretkey"
OBJECT_STORAGE_SERVER="Your S3 Host"
Install the plugin
php craft plugin/install behinddesign-craft-object-storage
Or browse to CP > Settings > Plugins to enable the plugin.
Configure
Within Settings -> Filesystems -> Add / Edit a filesystem
The dropdown for 'Filesystem Type' will now contain 'Generic S3' as an option.
Thanks!
fortrabbit The base setup for the S3 integration made significantly easier with their plugin. Added extra features which allow for a generic integration such as path style endpoints, the ability to select visibility. This means integration with minio is much easier.