Skip to main content

Configuration

All Copilot settings are managed through Preferences → AI Copilot. Changes are saved to the database and take effect immediately — no restart required.


Settings Reference

SettingDescription
Enable AI CopilotMaster toggle. Shows or hides the chat icon in the navbar.
Enable AI Copilot ManagementEnables conversation history, audit log, and rate-limit management pages.
AI ProviderWhich AI backend to use (OpenAI, Anthropic, Gemini, etc.).
ModelModel name. Leave blank to use the provider default (see table below).
API KeyYour provider API key. Not required for Ollama.
System PromptCustom instructions prepended to every conversation. Useful for setting tone or restricting scope.
Global ToolsWhich built-in tools the assistant can use on any page.
Quick ActionsPre-defined prompts shown as clickable buttons in the chat window.

Supported AI Providers

ProviderKeyNotes
OpenAIopenaiDefault. Enter your OPENAI_API_KEY.
AnthropicanthropicEnter your ANTHROPIC_API_KEY.
Google GeminigeminiEnter your GEMINI_API_KEY.
MistralmistralEnter your MISTRAL_API_KEY.
OllamaollamaSelf-hosted. Set OLLAMA_BASE_URL (default: http://localhost:11434). No API key needed.
Azure OpenAIazureRequires AZURE_OPENAI_API_KEY, AZURE_OPENAI_URL, and AZURE_OPENAI_DEPLOYMENT.
GroqgroqEnter your GROQ_API_KEY.
OpenRouteropenrouterEnter your OPENROUTER_API_KEY.
DeepSeekdeepseekEnter your DEEPSEEK_API_KEY.
xAI (Grok)xaiEnter your XAI_API_KEY.

Default Models

If you leave the Model field blank, the following defaults are used:

ProviderDefault model
OpenAIgpt-4o
Anthropicclaude-sonnet-4
Geminigemini-2.0-flash
Mistralmistral-large-latest
Ollamallama3

You can override the model at any time by entering a model name in the Model field (e.g. gpt-4o-mini, claude-3-5-haiku-latest).


API Keys

API keys can be supplied in two ways:

  1. Via Preferences UI — Enter the key directly in the API Key field. It is stored encrypted in the database and injected at runtime.
  2. Via environment variables — Set the appropriate variable in your docker-compose.yml (e.g. OPENAI_API_KEY). This is useful for self-hosted deployments where you prefer not to store secrets in the database.
note

Environment variable keys and UI keys can coexist. The UI key takes precedence if both are set.


System Prompt

The system prompt is prepended to every conversation as a hidden instruction. Use it to:

  • Set the assistant's tone or persona
  • Restrict the assistant to specific topics
  • Provide context about your setup (e.g. your server name or preferred language)

Example:

You are a helpful assistant for managing an IPTV playlist server.
Only answer questions related to M3U Editor and IPTV management.
Always respond in English.

Leave blank to use the default behaviour.


Environment Variables (Optional)

These variables can be set in your docker-compose.yml instead of using the Preferences UI:

VariableProvider
OPENAI_API_KEYOpenAI
ANTHROPIC_API_KEYAnthropic
GEMINI_API_KEYGoogle Gemini
MISTRAL_API_KEYMistral
GROQ_API_KEYGroq
OPENROUTER_API_KEYOpenRouter
DEEPSEEK_API_KEYDeepSeek
XAI_API_KEYxAI
OLLAMA_BASE_URLOllama (default: http://localhost:11434)
AZURE_OPENAI_API_KEYAzure OpenAI
AZURE_OPENAI_URLAzure OpenAI
AZURE_OPENAI_DEPLOYMENTAzure OpenAI
COPILOT_PROVIDERPre-select the default provider
COPILOT_MODELPre-select the default model