Installation

Quick start

The recommended way to install this extension is via Composer:

Install via Composer

composer require netresearch/nr-llm

After installation:

Activate the extension in Admin Tools > Extension Manager.
Configure providers and API keys in Admin Tools > LLM > Providers.
Define available models in Admin Tools > LLM > Models.
Create configurations in Admin Tools > LLM > Configurations.
Clear caches.

Composer installation

Requirements

Ensure your system meets these requirements:

PHP 8.2 or higher.
TYPO3 v13.4 or higher.
Composer 2.x.
netresearch/nr-vault ^0.4.0 (required for API key encryption; installed automatically via Composer).

Installation steps

Add the package

Install via Composer
```
composer require netresearch/nr-llm
```
Copied!
Activate the extension

Navigate to Admin Tools > Extension Manager and activate EXT:nr_llm.
Configure API keys

Use the setup wizard at Admin Tools > LLM > Setup Wizard to auto-detect your provider and discover models.

The setup wizard guides you through provider connection, model discovery, and configuration.

See Configuration reference for detailed setup instructions.
Clear caches

Flush all caches
```
vendor/bin/typo3 cache:flush
```
Copied!

Manual installation

If you cannot use Composer:

Download the extension from the TYPO3 Extension Repository (TER).
Extract to typo3conf/ext/nr_llm.
Activate in Admin Tools > Extension Manager.
Configure API keys and settings.

Warning

Manual installation requires manual dependency management. Composer installation is strongly recommended.

Database setup

The extension creates the following database tables automatically:

Table	Purpose
`tx_nrllm_provider`	Stores API provider connections with encrypted credentials.
`tx_nrllm_model`	Stores available LLM models with capabilities and pricing.
`tx_nrllm_configuration`	Stores use-case-specific configurations with prompts and parameters.
`tx_nrllm_task`	Stores one-shot prompt tasks for common operations.
`tx_nrllm_prompttemplate`	Stores reusable prompt templates with versioning and performance tracking.
`tx_nrllm_service_usage`	Tracks specialized service usage (translation, speech, image).

Run the database compare tool after installation:

Set up extension database tables

vendor/bin/typo3 extension:setup nr_llm

Cache configuration

The extension uses TYPO3's caching framework. Cache configuration is set up automatically — no backend is hardcoded. TYPO3 uses your instance's default cache backend, so Redis, Valkey, or Memcached work transparently if configured.

To override the cache backend specifically for nr-llm:

config/system/additional.php

use TYPO3\CMS\Core\Cache\Backend\RedisBackend;

$GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']
    ['cacheConfigurations']['nrllm_responses']
    ['backend'] = RedisBackend::class;

Upgrading

From previous versions

Backup your database before upgrading.
Run Composer update:

Update the extension
```
composer update netresearch/nr-llm
```
Copied!
Run database migrations:

Update database schema
```
vendor/bin/typo3 database:updateschema
```
Copied!
Clear all caches:

Flush all caches
```
vendor/bin/typo3 cache:flush
```
Copied!

Breaking changes

Check the Changelog for breaking changes between versions.

Uninstallation

To remove the extension:

Deactivate in Admin Tools > Extension Manager.
Remove via Composer:

Remove the extension
```
composer remove netresearch/nr-llm
```
Copied!

Clean up database tables if desired:

Drop extension database tables

DROP TABLE IF EXISTS tx_nrllm_provider;
DROP TABLE IF EXISTS tx_nrllm_model;
DROP TABLE IF EXISTS tx_nrllm_configuration;
DROP TABLE IF EXISTS tx_nrllm_configuration_begroups_mm;
DROP TABLE IF EXISTS tx_nrllm_task;
DROP TABLE IF EXISTS tx_nrllm_prompttemplate;
DROP TABLE IF EXISTS tx_nrllm_service_usage;

Remove any TypoScript includes referencing the extension.