Installation 

Quick start 

The recommended way to install this extension is via Composer:

Install via Composer
composer require netresearch/nr-llm
Copied!

After installation:

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

Composer installation 

Requirements 

Ensure your system meets these requirements:

  • PHP 8.5 or higher.
  • TYPO3 v14.0 or higher.
  • Composer 2.x.

Installation steps 

  1. Add the package

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

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

  3. Configure API keys

    See Configuration for detailed setup instructions.

  4. Clear caches

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

Manual installation 

If you cannot use Composer:

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

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_prompt_template Stores reusable prompt templates.

Run the database compare tool after installation:

Set up extension database tables
vendor/bin/typo3 extension:setup nr_llm
Copied!

Cache configuration 

The extension uses TYPO3's caching framework. Default configuration is automatically set up, but you can customize it:

config/system/additional.php
$GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations']['nrllm_responses'] = [
    'frontend' => \TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::class,
    'backend' => \TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend::class,
    'options' => [
        'defaultLifetime' => 3600,
    ],
    'groups' => ['nrllm'],
];
Copied!

Upgrading 

From previous versions 

  1. Backup your database before upgrading.
  2. Run Composer update:

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

    Update database schema
    vendor/bin/typo3 database:updateschema
    Copied!
  4. 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:

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

    Remove the extension
    composer remove netresearch/nr-llm
    Copied!
  3. 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_prompt_template;
    Copied!
  4. Remove any TypoScript includes referencing the extension.