swarnat/wp-s3-offload

Tool for Offloading Media to a custom S3 Storage

v1.2.5 2025-01-12 22:51 UTC

Requires

• php: >=8.1
• aws/aws-sdk-php: ~3.288.0

LGPL-3.0-or-later

• Stefan Warnat

• s3

README

⚠️ This currently is a WIP and not for production usage

This plugin provide functions to upload media directly or delayed to a s3 storage and replace the media URL with url from s3 storage.
The main purpose is the automated deployment in Kubernetes/OpenShift of Docker environments, where a stateless system is helpfull.

Setup

composer require swarnat/wp-s3-offload

This Plugin don't use any configuration UI, because it is used for automated deployment. You need to configure the following configuration variables in wp-config.php

// your access key
define('WPS3_KEY', '123...abc');
// your secret key to access bucket
define('WPS3_SECRET', '123...abc');

// name of the bucket, you want to connect to
define('WPS3_BUCKET', 'bucketname');
// region of bucket
define('WPS3_REGION', 'de-de');
// The folder within bucket to store files into
define('WPS3_FOLDER', '/');
// Should S3 access use pathstyle urls
define('WPS3_PATHSTYLE', true);

// URL to access the uploaded assets
define('WPS3_URL_PREFIX', 'https://s3.company.com/bucketname/');
// Define a custom URL endpoint
define('WPS3_ENDPOINT', 'https://s3.company.com');

Changelog

See CHANGELOG.md

ROADMAP

What is planned for next versions:

• automate upload of existing media
• testing