ciims-plugins/awsuploader

AWS S3 Uploader plugin for CiiMS

CiiAWSUploader Class

This class enables CiiMS to upload files to Amazon S3, isntead of uploading files to the uploads directory, _(*1)

Installation

This class should be installed with composer. After installing/uploading CiiMS, run this class, _(*2)

# composer require ciims-plugins/awsuploader dev-master # DEV
composer require ciims-plugins/awsuploader 1.0.0 # Versioned

How to Use

To use this class, you need to make a configuration change to your protected/config/params.php file., _(*3)

<?php return array(

    [...]
    'ciims_plugins' => array(
        'upload' => array(
            'class' => 'CiiAWSUploader',
            'options' => array(
                'bucket' => ''
                'AWS_ACCESS_KEY' => '',
                'AWS_SECRET_ACCESS_KEY' => '',
                'region' => '', // required; @see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html
                'cdn_domain' => 'https://cdn.example.com' // set to NULL if not used, if set, no trailing slash
            )
        )
    )
    [...]
);

Options

The following options are available for this class:, _(*4)

__AWS_ACCESS_KEY__ (required), _(*5)

Your AWS Access Key, _(*6)

__AWS_SECRET_ACCESS_KEY__ (required), _(*7)

Your AWS Secret Key, _(*8)

__bucket__ (required), _(*9)

The bucket name, _(*10)

__cdn_domain__ (optional), _(*11)

If you have a custom domain infront of AWS, you can specify it here. CiiMS will use this domain for the CDN urls instead of the default AWS domain, _(*12)