oaksend/craft-scaleway-object-storage

A Craft 4 plugin that integrates with Scaleway's S3 compatible Object Storage

1.0.0 2022-11-28 20:03 UTC

Requires

• php: ^8.0
• craftcms/cms: ^4.0.0
• craftcms/flysystem: ^1.0.0
• league/flysystem-aws-s3-v3: ^3.0.0

Requires (Dev)

• craftcms/phpstan: dev-main
• craftcms/rector: dev-main

MIT

• Oaksend
• Oliver Stark

• s3
• plugin
• Flysystem
• craftcms
• scaleway
• object-storage

README

This plugin is heavily based of the fortrabbit Object Storage Volume object.

This plugin provides an Object Storage integration for Craft CMS.

Requirements

The 3.0 branch of this plugin requires Craft CMS 4.0 and PHP 8.0 or later.

Installation

To install the plugin, follow these instructions.

1. Install the plugin via composer

cd /path/to/project

composer require oaksend/craft-scaleway-object-storage

2. Update your local .env file

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

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

If it fails for some reason, update your .env file manually.

SCALEWAY_STORAGE_BUCKET="(YOUR_BUCKET)"
SCALEWAY_STORAGE_HOST="s3.(nl-ams|fr-par|pl-waw).scw.cloud/(YOUR_BUCKET)"
SCALEWAY_STORAGE_KEY="(YOUR_API_KEY)"
SCALEWAY_STORAGE_REGION="(nl-ams|fr-par|pl-waw)"
SCALEWAY_STORAGE_SECRET="(YOUR_API_SECRET)"

3. Install the plugin

./craft plugin/install scaleway-object-storage

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

4. Configure

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

Select Scaleway Object Storage as Volume Type and for the Base URL field use $SCALEWAY_STORAGE_HOST ENV variable. All other fields are pre-configured with ENV vars already.