dodgycode / craft-bunny-storage
A bunny.net storage adapter for Craft CMS
Package info
github.com/dodgycde/craft-bunny-storage
Type:craft-plugin
pkg:composer/dodgycode/craft-bunny-storage
Requires
- php: ^8.2
- craftcms/cms: ^4.0|^5.0
- craftcms/flysystem: ^1.0|^2.0
- league/flysystem-path-prefixing: *
- platformcommunity/flysystem-bunnycdn: ^3.0
README
This plugin provides a bunny.net Storage & CDN integration for Craft CMS.
Requirements
This plugin requires Craft CMS 4.0.0+ or 5.0.0+.
What Does This Plugin Do?
This plugin allows you to use bunny.net Storage as your filesystem for storing assets and the like. It also allows usage of the Bunny CDN (pull zone) to serve bunny.net storage assets.
Installation
You can install this plugin from the Plugin Store or by using Composer.
From The Plugin Store
Go to the Plugin Store in your project’s Control Panel and search for “Bunny Storage”. Then press Install in its modal window.
Using Composer
Open your terminal and run the following commands:
# go to the project directory
cd /path/to/my-project.test
# tell Composer to load the plugin
composer require dodgycode/craft-bunny-storage
# tell Craft to install the plugin
./craft plugin/install craft-bunny-storage
Usage
To create a new asset filesystem on a Craft CMS project using Bunny Storage, go to Settings → Filesystems, create a new filesystem, and set the Filesystem Type setting to “Bunny Storage”. When configuring your filesystem, make sure you use ENV variables, since some of the settings contain secrets that should not be exposed through the generated project config files that result from entering data into these fields directly. Safety First!
Note: If using Bunny CDN, the Base URL for assets should be your CDN url
ENV File Values
In your project's ENV file, you should define the following, using your bunny.net account information:
# Bunny Storage
BUNNY_STORAGE_NAME=
BUNNY_STORAGE_PASSWORD=
# The primary region of the storage bucket
BUNNY_REGION=
# The URL used for the CDN/Pull zone (to serve files)
BUNNY_CDN='https://your-pull-zone.b-cdn.net'
# Your account level API key. Used for clearing caches automatically
BUNNY_API=
To find this information, log in to your Bunny dashboard and go to Storage. To access your files via CDN, connect your storage zone to a pull zone. For more setup information, please reference the Bunny Storage Quickstart Guide.
License & Support
This is a paid plugin offered by Dodgy Code through the Craft CMS plugin marketplace. Please log any issues under Issues on GitHub. Thank You!