ezsystems / ezdfs-fsbackend-aws-s3
eZPublish Amazon S3 FS backend for DFS
Installs: 8 710
Dependents: 0
Suggesters: 2
Security: 0
Stars: 4
Watchers: 18
Forks: 6
Type:ezpublish-legacy-extension
Requires
Requires (Dev)
- mockery/mockery: dev-master
- phpunit/phpunit: 3.7.*
This package is auto-updated.
Last update: 2024-10-07 23:53:43 UTC
README
Summary
An AmazonS3 DFS FS handler is added to the existing local filesystem one.
The previous eZDFSFileHandlerDFSBackend
, in charge of reading/writing files to NFS, is in DFS replaced by a dispatcher.
This dispatcher receives a stack of DFSBackend handlers. Each handler will respond true/false when asked if it supports
a file path.
An AmazonS3 handler is provided, that can be configured to store images.
Installation
Requirements
- ezsystems/ezdfs-fsbackend-dispatcher must be installed
- An amazon web services account, with
AmazonS3FullAccess
permissions like eZ Platform's S3 IO handler - ezsystems/ezpublish-legacy >= v2017.12 (Or any ezpublish 5+ version with the patch: https://github.com/ezsystems/ezpublish-legacy/pull/1449/files)
Installation using composer
From the eZ Publish Community/Platform root, run
$ composer require ezsystems/ezdfs-fsbackend-aws-s3:~2.0@beta ezsystems/ezdfs-fsbackend-dispatcher:~1.0@beta
Configuration
The handler must first be configured in an dfsamazons3.ini
override. Region must be set to the region code, as listed on http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region: eu-west-1
, us-east-1
...
Example settings/overrride/dfsamazons3.ini.append.php
:
<?php /* #?ini charset="utf-8"? [BackendSettings] # NOTE: If credentials are not set S3Client will attempt to load them from your environment AccessKeyID=<credentials.key> SecretAccessKey=<credentials.secret> Bucket=<your-bucket> Region=eu-west-1 # Version=latest */ ?>
It must then be be set as an additional handler matching one or several path in a dispatchabledfs.ini
override:
[DispatchableDFS]
PathBackends[var/ezdemo_site/storage/images]=eZDFSFileHandlerDFSAmazon
Known issues
When setting up Legacy Bridge, don't forget to follow the documentation here: https://doc.ezplatform.com/en/latest/guide/clustering_aws_s3/ .
If your images are not displayed properly, check the value of url_prefix
:
ezpublish:
system:
default:
io:
url_prefix: 'https://my-bucket.s3.my-region.amazonaws.com/$var_dir$/$storage_dir$'