Installation 

Quick start 

The recommended way to install this extension is via Composer:

composer require netresearch/nr-llm

After installation:

1. Run vendor/bin/typo3 extension:setup to create the schema and finish package setup. Composer-installed extensions are already active.
2. Run the setup wizard, the first entry in AI > Setup. It creates a provider, its models and a configuration in one pass. While no provider exists, AI > Overview opens with a button to it, and on TYPO3 v14 the AI > Setup overview does too.
3. Adjust what the wizard created, or add more, in AI > Setup > Providers, Models and Configurations.
4. Clear caches.

Composer installation 

Composer is required 

This guide supports Composer installations. The required nr-vault dependency also requires Composer; extracting a TER archive alone does not install a supported dependency chain.

Database setup 

Run extension:setup after Composer installation. The table below is an orientation, not a complete schema inventory; ext_tables.sql is the versioned source for all extension-owned tables and added core-table fields.

Run the database compare tool after installation:

vendor/bin/typo3 extension:setup

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:

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

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

Upgrading 

Uninstallation 

To remove the extension:

1. Stop nr-llm workers and scheduled jobs, remove consumer integrations and take a database backup. Decide which retained records must be exported.

2. Remove via Composer:

   Remove the extension

   composer remove netresearch/nr-llm

   Copied!

3. Back up the database before removing retained data. The following removes all nr-llm-owned tables in this version, including conversations, runs, approvals, usage and OAuth grants. Review the installed version's schema before running it. It does not remove nr-llm fields on core tables or secrets held separately in nr-vault; review those separately.

   Clean up the extension-owned 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_user_budget;
   DROP TABLE IF EXISTS tx_nrllm_configuration_begroups_mm;
   DROP TABLE IF EXISTS tx_nrllm_task;
   DROP TABLE IF EXISTS tx_nrllm_promptsnippet;
   DROP TABLE IF EXISTS tx_nrllm_term_list;
   DROP TABLE IF EXISTS tx_nrllm_glossary;
   DROP TABLE IF EXISTS tx_nrllm_service_usage;
   DROP TABLE IF EXISTS tx_nrllm_skill_source;
   DROP TABLE IF EXISTS tx_nrllm_skill;
   DROP TABLE IF EXISTS tx_nrllm_skill_approval;
   DROP TABLE IF EXISTS tx_nrllm_task_skill_mm;
   DROP TABLE IF EXISTS tx_nrllm_configuration_skill_mm;
   DROP TABLE IF EXISTS tx_nrllm_tool_state;
   DROP TABLE IF EXISTS tx_nrllm_tool_group_state;
   DROP TABLE IF EXISTS tx_nrllm_telemetry;
   DROP TABLE IF EXISTS tx_nrllm_skill_audit;
   DROP TABLE IF EXISTS tx_nrllm_eval_result;
   DROP TABLE IF EXISTS tx_nrllm_agentrun;
   DROP TABLE IF EXISTS tx_nrllm_agentrun_event;
   DROP TABLE IF EXISTS tx_nrllm_ai_session;
   DROP TABLE IF EXISTS tx_nrllm_ai_session_message;
   DROP TABLE IF EXISTS tx_nrllm_governance_event;
   DROP TABLE IF EXISTS tx_nrllm_mcp_server;
   DROP TABLE IF EXISTS tx_nrllm_mcp_tool;
   DROP TABLE IF EXISTS tx_nrllm_call_outcome;
   DROP TABLE IF EXISTS tx_nrllm_worker_heartbeat;
   DROP TABLE IF EXISTS tx_nrllm_mcp_oauth_grant;

   Copied!
4. Review added page/content columns with TYPO3's schema comparison. Remove only fields no longer used by an installed extension. Separately remove obsolete nr-llm grants from the groups' existing custom-permission field; these grants are not separate nr-llm columns on backend-user/group tables.
5. Flush the nrllm cache group and remove scheduled purge/worker jobs.
6. Review credentials and OAuth grants in nr-vault separately. Deleting nr-llm tables does not delete shared vault secrets. Revoke credentials at the provider only after checking other consumers.
7. Apply the organisation's backup/export retention policy. Live database cleanup does not erase earlier backups, logs or external provider data.