---
title: "Installation"
manual: "Imaginator"
version: "1.0"
permalink: "https://docs.typo3.org/permalink/schliesser/imaginator:installation@1.0"
source: "Installation/Index.rst"
rendered: "2026-10-13T11:21:40+00:00"
---

# Installation {#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](https://docs.typo3.org/permalink/schliesser/imaginator:configuration@1.0)).

## Installation with Composer {#installation-with-composer}

**Install via Composer**

```bash
composer require schliesser/imaginator
```

## Installation from TER {#installation-from-ter}

In a non-Composer (legacy) installation, fetch the extension from the
[TYPO3 Extension Repository](https://extensions.typo3.org/extension/imaginator) through
**Admin Tools > Extensions** in the backend, then activate it there.

## Signing key {#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](https://docs.typo3.org/permalink/schliesser/imaginator:image-endpoint@1.0) until re-rendered.

## Versioning {#installation-versioning}

This project uses [semantic versioning](https://semver.org/), 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.