Download the PHP package elysiumrealms/imageable without Composer
On this page you can find all versions of the php package elysiumrealms/imageable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download elysiumrealms/imageable
More information about elysiumrealms/imageable
Files in elysiumrealms/imageable
Package imageable
Short Description Imageable Eloquent Model Extension
License MIT
Homepage https://github.com/elysiumrealms/imageable
Informations about the package imageable
Imageable Upload System
A module for uploading and managing images.
Installation Guide
Install the package using Composer.
Run the migrations.
Implementation Guide
Use the ImageableTrait trait to your model.
Schedule the imageable:prune command to prune deleted images.
Storage Mode Configuration
The imageable module supports two storage modes:
Proxy Forwarding Mode
Images are stored locally on the backend server or AWS S3 Bucket, access all images through imageable/{image} route.
The Proxy Forwarding Mode is designed for cases where AWS S3 Bucket is not available or when the system is not yet deployed to a production environment. In production, the Direct Storage Mode is preferred to reduce backend system I/O and improve performance.
Direct Storage Mode (Recommended for Production)
Images are stored in an AWS S3 Bucket, and the system returns the full AWS S3 Bucket URL or file path for access.
In direct Direct Storage Mode mode, all images will be served directly from AWS S3 Bucket or file path on the backend server.
Deployment Considerations
Development/Test Environments
- Use Proxy Forwarding Mode to simulate image retrieval before setting up AWS S3 Bucket.
Production Environment
- Use Direct Storage Mode to reduce backend load and improve performance.
- Set the Storage Mode through
IMAGEABLE_DRIVERenvironment variable to desired driver.
Configuration
- When using Direct Storage Mode and
s3driver, ensure proper AWS S3 Bucket permissions and bucket policies. - Configure reverse proxy rules to handle image routing when using Proxy Forwarding Mode.
Usage Guide
-
Upload images through the
POST /api/v1/imageable/{collection}route. -
Delete images through the
DELETE /api/v1/imageableroute. -
Get images paginated through the
GET /api/v1/imageableroute. - Access the images through the
imagesrelationship.
For further details, please contact the development team.