Files
waggle-os/.env.example
shumeiko.it e0836388f1 docs: record the separate data directory (ADR-0011)
Add ADR-0011: the community edition defaults to ~/.waggle-community, a
temporary name that follows the product-name decision (Q8), and copies
nothing from the commercial ~/.waggle. It supersedes point 4 of
ADR-0009 and closes the pending "separate data directory" decision.

Update the install guide, troubleshooting, capabilities, memory,
architecture, the Windows build notes, THREAT_MODEL, README,
.env.example and the changelog. Log UF-068 (Open): marketplace skills
and plugins ignore a custom data directory.
2026-11-04 10:32:08 +01:00

40 lines
2.1 KiB
Plaintext

# Optional settings for running the sidecar from source. A basic local run
# needs none of them: keys are entered in the app and kept in the encrypted
# vault (~/.waggle-community/vault.json).
# ── Provider API keys ──────────────────────────────────────────────
# Set keys in the app under Settings > Models (Provider Keys) or in the Vault
# app. The server loads them from the vault at startup, so you normally do not
# set them here. Providers: anthropic, openai, google (gemini), xai, deepseek,
# openrouter, mistral, moonshot (kimi), alibaba (qwen), minimax, zhipu (glm),
# perplexity, genspark, and tavily for web search.
#
# These are also read from the environment, for CI and headless runs:
# ANTHROPIC_API_KEY=
# OPENAI_API_KEY=
# VOYAGE_API_KEY= # embeddings only (EMBEDDING_PROVIDER=voyage)
# ── Data directory and port ────────────────────────────────────────
# Default: ~/.waggle-community, kept apart from the commercial Waggle's ~/.waggle.
# WAGGLE_DATA_DIR=~/.waggle-community
# WAGGLE_PORT=3333
# ── LiteLLM (optional) ─────────────────────────────────────────────
# Off by default; the built-in provider proxy handles model calls. Point the
# sidecar at an external LiteLLM-compatible proxy only if you run one.
# LITELLM_BASE_URL=http://localhost:4000
# LITELLM_MASTER_KEY=
# ── Embeddings ─────────────────────────────────────────────────────
# auto (default) tries in-process, then Ollama, then an API provider.
# Options: auto, inprocess, ollama, voyage, openai, mock
# EMBEDDING_PROVIDER=auto
# In-process model: downloads about 23 MB on first use, cached in
# ~/.waggle-community/models/, then works offline.
# EMBEDDING_MODEL=Xenova/all-MiniLM-L6-v2
# Ollama: needs Ollama running (https://ollama.com).
# OLLAMA_HOST=http://localhost:11434
# OLLAMA_EMBED_MODEL=nomic-embed-text