Installation

Imaginator can be installed with Composer or from the TYPO3 Extension Repository (TER) via the Extension Manager.

Tip

Installing the extension is enough to use the <i:image> ViewHelper. No Site Set or TypoScript is required. Configure the extension under Settings > Extension Configuration > imaginator (see Configuration).

Installation with Composer

Install via Composer

composer require schliesser/imaginator

Installation from TER

In a non-Composer (legacy) installation, fetch the extension from the TYPO3 Extension Repository through Admin Tools > Extensions in the backend, then activate it there.

Signing key

The signing secret is derived automatically from $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'], which is set on every standard TYPO3 install. No configuration is needed.

Warning

Changing encryptionKey invalidates previously generated image URLs. Flush the frontend caches after changing it. Already-cached HTML pointing at the old signatures returns 403 until re-rendered.

Versioning

This project uses semantic versioning, which means that

bugfix updates (e.g. 1.0.0 => 1.0.1) just include small bugfixes or security-relevant stuff without breaking changes,
minor updates (e.g. 1.0.0 => 1.1.0) include new features and smaller tasks without breaking changes, and
major updates (e.g. 1.0.0 => 2.0.0) contain breaking changes, which can be refactorings, features or bugfixes.