README

A TYPO3 FAL (File Abstraction Layer) driver that exposes assets and collections from a CELUM DAM system as a read-only TYPO3 file storage. Uses the CELUM REST API to fetch and cache asset metadata, preview URLs, and download links.

Extension key: celum_connect_fal
Package: ecentral/celum-connect-fal
Driver identifier: BrixCelumDriver
TYPO3 compatibility: 12.4 LTS, 13.4 LTS

Requirements

TYPO3 CMS 12.4 LTS or 13.4 LTS
PHP 8.1 or higher
A running CELUM DAM instance with REST API access

Installation

composer require ecentral/celum-connect-fal

Then activate the extension via the TYPO3 backend under Admin Tools > Extensions, or via CLI:

./vendor/bin/typo3 extension:activate celum_connect_fal

Configuration

The driver is configured per FAL storage in the TYPO3 backend under File > Filelist > [Storage] > Edit. Select Driver: BrixCelumDriver and fill in the FlexForm fields:

Field	Type	Required	Default	Description
`celumHost`	string	yes	—	Base URL of the CELUM REST API, e.g. `https://your-celum-instance.celum.com`
`celumApiKey`	string	yes	—	API key for authentication with the CELUM REST API (see Finding your API Key)
`celumUser`	string	yes	—	Optional username for HTTP basic authentication
`celumPassword`	string	yes	—	Optional password for HTTP basic authentication
`roots`	string	yes	—	Comma-separated list of CELUM collection IDs to expose as root folders, e.g. `12,34,56` (see Finding Root Node IDs)
`locale`	`en` \| `de`	no	`en`	Language used for asset names returned by the API
`defaultLocale`	`en` \| `de`	no	`en`	Fallback language when the primary locale is unavailable
`imageDownloadFormat`	string	no	`largeprvw`	CELUM format key used for image public URLs (e.g. `largeprvw`, `preview`, `thumbnail`)
`cacheLifetimeInMinutes`	integer (1–29)	no	`29`	How long API responses are cached in the TYPO3 cache framework

Finding your API Key

The API key is generated in the CELUM Configuration Management Application (CMA):

Log in to your CELUM backend (e.g. https://your-instance.celum.cloud)
Navigate to Advanced UI (older user interface)
Go to Administration > Configuration Management and log in there
Under the Authentication category, click Profiles, then click + ADD to create a new authentication profile
Select Rest API — a dialog will open where you can retrieve the API key

Tip: Create a dedicated API user for TYPO3 to control access rights precisely.

Finding Root Node IDs

The root node ID is the numerical ID of the CELUM folder that will serve as the entry point in the TYPO3 file selection:

In CELUM Content, navigate to the folder you want to use as the root - the ID is visible in the URL (e.g. 1234_node)
Open the folder's Detail View — the ID is visible in the upper left corner.

Multiple root node IDs can be entered as a comma-separated list — all configured nodes and their sub-nodes will be available recursively in TYPO3.

Usage

Creating a FAL Storage

Go to Web > List > Page Pid=0.
Create a new file storage record.
Set Driver to BrixCelumDriver.
Fill in the connection settings under the Configuration tab (see Configuration).
Save. TYPO3 will connect to the CELUM REST API and expose the configured root collections as folders.

Read-Only Storage

The CELUM driver is read-only. All write operations (upload, rename, move, delete) will throw an exception. Assets must be managed inside CELUM and will be reflected automatically after the cache TTL expires.

Clearing the Cache

A dedicated cache-clear button is available in the TYPO3 backend toolbar. To activate it, add the following TS-Config under the user or group settings:

options.clearCache.celum = 1

This clears all cached CELUM API responses immediately.

ecentral / celum-connect-fal

Maintainers

Package info

Statistics

Security