Documentation navigation
Docs/Install/Essential settings

Essential settings

Set server auth, embedding, View LLM, Redis cache, and backup defaults used by daily operation.

Use this page as the checklist for the settings that make Lore usable after installation.

There are two kinds of settings:

KindWhere to set itExamples
Deployment settingsServer environment or Docker Compose .envdatabase URL, API token, Redis, storage paths
Runtime settings/setup, /settings, or /api/settingsembedding model, View LLM, recall, Dream, backup policy

A good rule: set infrastructure values before the server starts, then use the Web Console for model and memory behavior.

Required server setting

SettingSet it inWhat it does
DATABASE_URLWeb server environmentConnects Lore Web to PostgreSQL. The server cannot start correctly without it.

For Docker Compose, DATABASE_URL usually points at the bundled postgres service. For managed PostgreSQL, point it at your own host.

SettingSet it whenNotes
API_TOKENThe server is reachable by anything you do not fully trustUse the same token in the Web UI, MCP clients, and hooks.
REDIS_URLYou run more than one server process or want shared cacheLore can run without Redis, but Redis is better for shared deployments.
CACHE_KEY_PREFIXRedis is shared with other appsKeeps Lore keys separate.
CACHE_LOCAL_MAX_ITEMSYou are not using RedisLimits the in-process fallback cache.
LORE_DB_POOL_SIZEYou need to tune database connectionsDefault is 10; keep it small unless you know you need more.

Docker Compose deployments also use host-side paths such as POSTGRES_DATA_DIR, REDIS_DATA_DIR, and SNAPSHOT_DATA_DIR so data survives container restarts.

Runtime model settings

Configure these in /setup first, then adjust them later in /settings:

Setting groupRequired forRecommendation
Embedding provider, base URL, API key, modelSemantic recall and index rebuildsUse an OpenAI-compatible embedding endpoint.
View LLM provider, base URL, API key, modelGenerated views and DreamUse a model that follows structured instructions reliably.
Recall settingsWhat agents see in recall blocksStart with defaults; tune after you have real memory content.
Dream settingsMemory maintenance suggestionsKeep manual review enabled until you trust the workflow.
Backup settingsSafe cleanup and migrationConfigure before large edits or Dream runs.

Quick diagnosis

SymptomCheck first
Server does not startdocker compose ps and docker compose logs web from the directory with docker-compose.yml
Web Console works but MCP failsAPI_TOKEN, MCP URL, client_type, agent environment
Recall returns weak resultsmemory content, disclosure, glossary, then recall thresholds
Dream cannot generate useful suggestionsView LLM settings and memory quality
Quick installUse the installer to start Lore with Docker or connect clients to an existing Lore server.Manual configurationConfigure the Lore server and agent integrations by hand when you do not use the installer script.Use your own PostgreSQLRun Lore against an existing PostgreSQL instance with pgvector and optional Chinese full-text search extensions.First-run setupOpen /setup, configure model endpoints, bootstrap memory, and restart connected runtimes.