blomstra/s3-assets

Relocate Flarum disks onto S3 or compatible bucket

0.1.3-beta.3 2024-09-12 20:29 UTC

Requires

• flarum/core: ^1.3.1
• league/flysystem-aws-s3-v3: *
• vlucas/phpdotenv: ^5.4

proprietary

• Team Blomstra

• flarum

README

A Flarum extension. Relocate Flarum disks onto S3 or compatible bucket

Installation

Install with composer:

composer require blomstra/s3-assets:"*"

Updating

composer update blomstra/s3-assets
php flarum cache:clear

Configuration

The S3 (or compatible) bucket can be configured either by environment variables or via the extension settings. If the environment variables are set, they will override the settings entered in the admin panel, if set.

Environment variables

• AWS_ACCESS_KEY_ID - your access key ID
• AWS_SECRET_ACCESS_KEY - your secret
• AWS_DEFAULT_REGION - the region
• AWS_BUCKET - the bucket name
• AWS_URL - the public facing base URL of the bucket
• AWS_ENDPOINT - the ARN
• AWS_ACL - The ACL, if any, that should be applied to the uploaded object (default: private). For possible values, see AWS Docs
• AWS_PATH_STYLE_ENDPOINT - boolean value

If you plan to setup the S3 configuration using the environment variables, please ensure these are set before enabling the extension

Transferring assets from the existing filesystem to the S3 bucket

After your new bucket is configured, any exisiting files, will not exist there (ie uploaded avatars, profile covers, etc).

Use the provided command to start moving these files:

php flarum s3:move

Links

• Extiverse
• Discuss