Skip to content

Commit

Permalink
Update docs and prep for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
croxton committed May 3, 2023
1 parent ac48768 commit 7456546
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 7 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).

## 2.1.3 - 2023.05.03
### Added
- Support for Servd's Asset Platform v3.

## 2.1.2 - 2023.02.23
### Fixed
- Fixed image previews in SEOmatic link cards.
Expand Down
52 changes: 46 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,16 +176,38 @@ There are several ways to use Imgixer with [Servd.host](https://servd.host) asse
With either option, you will first need to install [Servd Assets and Helpers](https://github.com/servdhost/craft-asset-storage).

### 1. Using an Imgix Web Folder source

* Set up a Web Folder source in Imgix with the base URL set to Servd's CDN URL for your project, e.g. `https://cdn2.assets-servd.host/my-served-project-slug`.

#### Servd Assets Platform v2
* Set up a `Web Folder` source in Imgix with the base URL set to Servd's CDN URL for your project, e.g. `https://cdn2.assets-servd.host/my-served-project-slug`.

* Recommended: tick the option to use secure URLs and make a note of the key.

* Create a source in `imgixer.php` config, adding `servd` as the asset transform provider:
* Create a new source in `imgixer.php` config:

```php
'my-servd-web-folder' => array(
'provider' => 'servd',
'provider' => 'imgix',
'endpoint' => 'my-domain.imgix.net',
'privateKey' => '12345',
'signed' => true,
'defaultParams' => array(
'auto' => 'compress,format',
'fit' => 'crop',
'q' => '80'
)
),
```

#### Servd Assets Platform v3
* Set up a `Web Folder` source in Imgix with the base URL set to Servd's *file* domain for your project e.g. `https://my-served-project-slug.files.svdcdn.com` (if you have set up a custom file domain, use that instead).

* Recommended: tick the option to use secure URLs and make a note of the key.

* Create a new source in `imgixer.php` config:

```php
'my-servd-web-folder' => array(
'provider' => 'imgix',
'endpoint' => 'my-domain.imgix.net',
'privateKey' => '12345',
'signed' => true,
Expand All @@ -199,13 +221,31 @@ With either option, you will first need to install [Servd Assets and Helpers](ht

### 2. Use Servd's own image transformation service

Servd provides its own image transformation service (https://optimise2.assets-servd.host) that supports a subset of Imgix's Rendering API and covers the majority of use cases. If you are hosting with Servd it may be all you need.
Servd's Asset Platform provides an image transformation service that supports a subset of Imgix's Rendering API and covers the majority of use cases. If you are hosting with Servd it may be all you need.

#### Servd Assets Platform v2

Create a source in `imgixer.php` config, adding `servd` as the asset provider. Do not set an endpoint:

```php
'my-servd-assets' => array(
'provider' => 'servd',
'defaultParams' => array(
'auto' => 'format',
'fit' => 'crop',
'q' => '80'
)
),
```

#### Servd Assets Platform v3

Create a source in `imgixer.php` config, adding `servd` as the asset provider. Do not set a domain:
Create a source in `imgixer.php` config, adding `servd` as the asset provider. Add Servd's *transform* domain as the endpoint for the source (if you have set up a custom transform domain, use that instead).

```php
'my-servd-assets' => array(
'provider' => 'servd',
'endpoint' => , 'https://my-served-project-slug.transforms.svdcdn.com'
'defaultParams' => array(
'auto' => 'format',
'fit' => 'crop',
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "croxton/imgixer",
"description": "Generate Imgix URLs.",
"type": "craft-plugin",
"version": "2.1.2",
"version": "2.1.3",
"keywords": [
"craft",
"cms",
Expand Down

0 comments on commit 7456546

Please sign in to comment.