A Craft 3 plugin that integrates with fortrabbit's S3 compatible Object Storage
Switch branches/tags
Clone or download

README.md

fortrabbit Object Storage Volume for Craft CMS

This plugin provides an Object Storage integration for Craft CMS.

Requirements

This plugin requires Craft CMS 3.0.0 and PHP 7.1 or later. There is another plugin to provide this for Craft 2 over here.

Installation

To install the plugin, follow these instructions.

1. Intall the plugin via composer

cd /path/to/project

composer config platform --unset
composer require fortrabbit/craft-object-storage

2. Update your local .env file

Learn how to access credentials on fortrabbit.

OBJECT_STORAGE_BUCKET="(YOUR_APP_NAME)"
OBJECT_STORAGE_HOST="(YOUR_APP_NAME).objects.frb.io"
OBJECT_STORAGE_KEY="(YOUR_APP_NAME)"
OBJECT_STORAGE_REGION="(us-east-1|eu-west-1)"
OBJECT_STORAGE_SECRET="(OBJECT_STORAGE_SECRET)"
OBJECT_STORAGE_SERVER="objects.(us1|eu2).frbit.com"

3. Install the plugin

./craft install/plugin fortrabbit-object-storage

Or browse to CP > Settings > Plugins to enable the plugin.

4. Configure

The plugin creates a config volumes.php file in /path/to/project/config/. This is the place to configure your Volumes. To apply the changes you need to "Sync" the changes in the CP, under Settings > Assets.