PHPackages                             plato-creative/silverstripe-imgix - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. plato-creative/silverstripe-imgix

AbandonedArchivedSilverstripe-vendormodule[Utility &amp; Helpers](/categories/utility)

plato-creative/silverstripe-imgix
=================================

Integrates imgix with silverstripe.

4.0.3(5y ago)62.2k4[2 issues](https://github.com/mediabeastnz/silverstripe-imgix/issues)BSD-3-ClausePHP

Since Sep 14Pushed 5y agoCompare

[ Source](https://github.com/mediabeastnz/silverstripe-imgix)[ Packagist](https://packagist.org/packages/plato-creative/silverstripe-imgix)[ RSS](/packages/plato-creative-silverstripe-imgix/feed)WikiDiscussions master Synced 4w ago

READMEChangelog (4)Dependencies (3)Versions (6)Used By (0)

SilverStripe imgix
==================

[](#silverstripe-imgix)

Integrates [imgix](https://docs.imgix.com/) with silverstripe.

Requirements
------------

[](#requirements)

- [SilverStripe ^4](https://www.silverstripe.org/)
- [imgix-php](https://github.com/imgix/imgix-php)

Installation
------------

[](#installation)

```
composer require plato-creative/silverstripe-imgix

```

License
-------

[](#license)

See [License](license.md)

Configuration
-------------

[](#configuration)

Define imgix source in your site config.yml file as below

```
PlatoCreative\Imgix\Imgix:
  sub_domain: 'example'
  secure_url_token: '1234567891234' # (Optional) Defines the signkey for private sources
  folder_path: 'assets/Banners/' # (Optional) Default path id assets/
```

Set the Imgix class to be used for new Image uploads

```
SilverStripe\Assets\File:
  class_for_file_extension:
    '*': 'File'
    'jpg': PlatoCreative\Imgix\Imgix
    'jpeg': PlatoCreative\Imgix\Imgix
    'png': PlatoCreative\Imgix\Imgix
    'gif': PlatoCreative\Imgix\Imgix
```

Responsive Images
-----------------

[](#responsive-images)

[Imgix.js](https://www.imgix.com/imgix-js) is required for responsive images. Use one of the following methods to install.

Bower:

```
bower install --save imgix.js

```

NPM:

```
npm install --save imgix.js

```

[Manual Download](https://raw.githubusercontent.com/imgix/imgix.js/master/dist/imgix.min.js)

[For more information check out the official documentation](https://www.imgix.com/imgix-js)

Maintainers
-----------

[](#maintainers)

- Gorrie

Bugtracker
----------

[](#bugtracker)

Bugs are tracked in the issues section of this repository. Before submitting an issue please read over existing issues to ensure yours is unique.

If the issue does look like a new bug:

- Create a new issue
- Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here.
- Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules.

Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.

Development and contribution
----------------------------

[](#development-and-contribution)

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Adding to a DataObject
----------------------

[](#adding-to-a-dataobject)

Add a has\_one or many\_many relationship to "Imgix::class" in the same way you would with "Image::class". See example below

```
