Search by

fortrabbit / craft-object-storage

fortrabbit

A Craft 5 plugin that integrates with fortrabbit's S3 compatible Object Storage

Package info

github.com/fortrabbit/craft-object-storage

Homepage

Documentation

Type:craft-plugin

pkg:composer/fortrabbit/craft-object-storage

Statistics

Installs: 20 127

Dependents: 2

Suggesters: 0

Stars: 4

Open Issues: 2

4.0.1 2026-11-19 11:06 UTC

README

This plugin provides an Object Storage integration for Craft CMS.

Requirements

The 4.0 release of this plugin requires Craft CMS 5 and PHP 8.2 or later.

Craft CMS 6 no longer supports filesystem plugins. Configure Object Storage as a Laravel disk instead, see the Craft 6 upgrade guide.

Installation

To install the plugin, follow these instructions.

1. Install the plugin via composer

cd /path/to/project

composer require fortrabbit/craft-object-storage

2. Update your local .env file

Run this command in the terminal to update your .env automatically:

./vendor/bin/object-storage-init {your-app}

If it fails for some reason, update your .env file manually. 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 plugin/install fortrabbit-object-storage

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

4. Configure

Configure filesystems under: Settings > Filesystems >> [New Filesystem].

  • Select fortrabbit Object Storage as Filesystem Type.
  • For the Base URL field use $OBJECT_STORAGE_HOST ENV variable. All other fields are pre-configured with ENV vars already.
  • Optionally set a value for Expires (Cache expiration period), like 2 weeks

Configure volumes under: Settings > Assets > [New Volume].

  • Select the filesystem created above as the Asset Filesystem.