Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/dallay/corvus/llms.txt

Use this file to discover all available pages before exploring further.

​
Configuration File Location

Corvus stores its configuration in ~/.corvus/config.toml by default. This file is automatically created during onboarding with secure permissions (mode 0600 on Unix systems).

​
Custom Configuration Directory

You can override the configuration directory using the CORVUS_WORKSPACE environment variable: 
export CORVUS_WORKSPACE=/path/to/custom/workspace
corvus status
The configuration path resolution follows this priority:
  1. CORVUS_WORKSPACE environment variable
  2. Persisted active workspace marker from onboarding
  3. Default ~/.corvus layout

​
Configuration Structure

The configuration file is organized into the following sections:

Providers

AI model provider settings (API keys, models, endpoints)

Channels

Messaging platform integrations (Telegram, Discord, etc.)

Memory

Memory backend configuration and embedding settings

Security

Gateway security, autonomy levels, and runtime isolation

​
Core Configuration Fields

​
api_key
string
Primary API key for the default provider. Automatically encrypted when secrets.encrypt = true.
​
api_url
string
Base URL override for provider API (e.g., http://10.0.0.1:11434 for remote Ollama).
​
default_provider
string
default:"openrouter"
Default AI provider to use. See Providers for supported values.
​
default_model
string
default:"anthropic/claude-sonnet-4"
Default model to use with the provider.
​
default_temperature
number
Default temperature for model inference (0.0-2.0). Higher values increase randomness.

​
Environment Variable Overrides

Environment variables take precedence over config file values:

​
Provider Settings

export CORVUS_API_KEY=sk-...
export CORVUS_PROVIDER=anthropic
export CORVUS_MODEL=claude-opus-4-20250514
export CORVUS_TEMPERATURE=0.9

​
Gateway Settings

export CORVUS_GATEWAY_PORT=8080
export CORVUS_GATEWAY_HOST=0.0.0.0
export CORVUS_ALLOW_PUBLIC_BIND=true

​
Memory Settings

export CORVUS_MEMORY_BACKEND=surreal
export CORVUS_SURREALDB_URL=http://127.0.0.1:8000
export CORVUS_SURREALDB_NAMESPACE=corvus
export CORVUS_SURREALDB_DATABASE=memory

​
Configuration Validation

Corvus validates configuration at runtime to catch errors early:
  • MCP servers: Validates command paths, timeout values, and environment variables
  • Security permissions: Ensures config file has secure permissions (Unix: 0600)
  • Required fields: Checks for missing required fields based on enabled features

​
Quick Setup

The interactive wizard walks you through all configuration options:
corvus onboard --interactive
This prompts for:
  • Provider and API key
  • Memory backend
  • Channel configurations
  • Security settings

​
Configuration Example

Here’s a complete example configuration file: 
api_key = "enc:..."  # Encrypted when secrets.encrypt = true
default_provider = "openrouter"
default_model = "anthropic/claude-sonnet-4-20250514"
default_temperature = 0.7

[memory]
backend = "sqlite"
auto_save = true
embedding_provider = "openai"
vector_weight = 0.7
keyword_weight = 0.3

[gateway]
port = 3000
host = "127.0.0.1"
require_pairing = true
allow_public_bind = false

[autonomy]
level = "supervised"
workspace_only = true
allowed_commands = ["git", "npm", "cargo"]
forbidden_paths = ["/etc", "/root"]

[runtime]
kind = "native"

[runtime.docker]
image = "alpine:3.20"
network = "none"
memory_limit_mb = 512

​
Security Best Practices

Never commit config.toml to version control. It contains encrypted secrets that are tied to your local machine.
  1. Use encrypted secrets: Enable secrets.encrypt = true (default) to encrypt API keys
  2. Secure file permissions: Keep config file mode at 0600 (owner read/write only)
  3. Environment variables: Use environment variables for CI/CD pipelines instead of config files
  4. Regular key rotation: Rotate API keys periodically and update configuration

​
Configuration Backup

Corvus automatically creates a backup when saving configuration:
  • Backup file: ~/.corvus/config.toml.bak
  • Atomic writes with temp files prevent corruption
  • Directory fsync ensures durability

​
Next Steps

Configure Providers

Set up AI model providers and API keys

Set Up Channels

Enable messaging platform integrations

Configure Memory

Choose memory backend and embedding settings

Security Settings

Configure autonomy levels and runtime isolation

Build docs developers (and LLMs) love

Get started for freeTalk to us