Installation
Quick start
The recommended way to install this extension is 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.5 or higher.
- TYPO3 v14.0 or higher.
- Composer 2.x.
Installation steps
-
Add the package
Install via Composercomposer require netresearch/nr-llmCopied! -
Activate the extension
Navigate to Admin Tools > Extension Manager and activate EXT:nr_llm.
-
Configure API keys
See Configuration for detailed setup instructions.
-
Clear caches
Flush all cachesvendor/bin/typo3 cache:flushCopied!
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_ | Stores API provider connections with encrypted credentials. |
tx_ | Stores available LLM models with capabilities and pricing. |
tx_ | Stores use-case-specific configurations with prompts and parameters. |
tx_ | Stores reusable prompt templates. |
Run the database compare tool after installation:
vendor/bin/typo3 extension:setup nr_llm
Cache configuration
The extension uses TYPO3's caching framework. Default configuration is automatically set up, but you can customize it:
$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'],
];
Upgrading
From previous versions
- Backup your database before upgrading.
-
Run Composer update:
Update the extensioncomposer update netresearch/nr-llmCopied! -
Run database migrations:
Update database schemavendor/bin/typo3 database:updateschemaCopied! -
Clear all caches:
Flush all cachesvendor/bin/typo3 cache:flushCopied!
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 extensioncomposer remove netresearch/nr-llmCopied! -
Clean up database tables if desired:
Drop extension database tablesDROP 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! - Remove any TypoScript includes referencing the extension.