fof / s3-assets
Relocate Flarum disks onto S3 or compatible bucket
Fund package maintenance!
Website
Installs: 150
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Type:flarum-extension
Requires
- php: ^8.0
- flarum/core: ^1.8
- league/flysystem-aws-s3-v3: ^1.0
- vlucas/phpdotenv: ^5.4
Requires (Dev)
- flarum/phpstan: *
- flarum/testing: ^1.0.0
- fof/upload: *
Replaces
This package is auto-updated.
Last update: 2024-12-02 13:50:07 UTC
README
A Flarum extension. Relocate Flarum disks onto S3 or compatible bucket
Installation
Install with composer:
composer require fof/s3-assets:"*"
Updating
composer update fof/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
FOF_S3_ACCESS_KEY_ID
- your access key ID *FOF_S3_SECRET_ACCESS_KEY
- your secret *FOF_S3_REGION
- the region *FOF_S3_BUCKET
- the bucket name *FOF_S3_URL
- the public facing base URL of the bucketFOF_S3_ENDPOINT
- the ARNFOF_S3_ACL
- The ACL, if any, that should be applied to the uploaded object. For possible values, see AWS DocsFOF_S3_PATH_STYLE_ENDPOINT
- boolean valueFOF_S3_CACHE_CONTROL
- Optional. Specify themax-age
header files should be served with, for example3153600
(1 year).0
or not set = no caching.
*
denotes the minimum requirements for using S3 on AWS. S3-compatible services will require more.
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 copying these files. An optional additional paramater --move
will delete the files from your local filesystem after a successful copy.
php flarum fof:s3:copy --move