calips-labs / scaleway-object-storage
Scaleway Object Storage integration for Craft CMS
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:craft-plugin
Requires
- php: ^8.0.2
- craftcms/cms: ^4.0.0-beta.1 || ^5.0.0-beta.1
- craftcms/flysystem: ^1.0.0 || ^2.0.0
- league/flysystem-aws-s3-v3: ^3.0.0
Requires (Dev)
- craftcms/ecs: dev-main
- craftcms/phpstan: dev-main
- craftcms/rector: dev-main
README
Scaleway Object Storage filesystem for Craft CMS
Requirements
This plugin requires Craft CMS ^4.0.0-beta.1 and PHP ^8.0.2
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project
-
Then tell composer to load the plugin:
composer require calips-labs/scaleway-object-storage
-
Navigate to Settings -> Plugins and click the "Install" button for Scaleway Object Storage.
API keys
You can create an API key in the Scaleway console. An API key consists of an Access Key ID and a Secret Access Key.
When you configure an API key, make sure that it has access to the bucket you want to use.
At least the following permissions are
needed: ObjectStorageBucketsRead
, ObjectStorageObjectsRead
, ObjectStorageObjectsWrite
, ObjectStorageObjectsDelete
.
Configuring a new filesystem
- Navigate to Settings -> Filesystems and click the "New Filesystem" button.
- Select "Scaleway Object Storage" from the "Filesystem Type" dropdown.
- Select the region for your bucket.
- Enter your Access Key ID, and Secret Access Key (it's recommended to store these in your
.env
file and reference the environment variables here). - Hit Refresh to load the bucket list, or choose the Manual option and enter the bucket name. (The bucket name can also
be stored in your
.env
file and be referenced here.) - Save the filesystem.
Misc
Open an Issue if you encounter any problems or have suggestions.
Acknowledgements
Based on the excellent Cloudflare R2 plugin by Jarrod D Nix