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.
This commit is contained in:
shumeiko.it
2026-11-04 10:31:47 +01:00
parent ad222e8bf3
commit e0836388f1
16 changed files with 99 additions and 21 deletions

View File

@@ -1,6 +1,6 @@
# 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/vault.json).
# vault (~/.waggle-community/vault.json).
# ── Provider API keys ──────────────────────────────────────────────
# Set keys in the app under Settings > Models (Provider Keys) or in the Vault
@@ -15,7 +15,8 @@
# VOYAGE_API_KEY= # embeddings only (EMBEDDING_PROVIDER=voyage)
# ── Data directory and port ────────────────────────────────────────
# WAGGLE_DATA_DIR=~/.waggle
# Default: ~/.waggle-community, kept apart from the commercial Waggle's ~/.waggle.
# WAGGLE_DATA_DIR=~/.waggle-community
# WAGGLE_PORT=3333
# ── LiteLLM (optional) ─────────────────────────────────────────────
@@ -30,7 +31,7 @@
# EMBEDDING_PROVIDER=auto
# In-process model: downloads about 23 MB on first use, cached in
# ~/.waggle/models/, then works offline.
# ~/.waggle-community/models/, then works offline.
# EMBEDDING_MODEL=Xenova/all-MiniLM-L6-v2
# Ollama: needs Ollama running (https://ollama.com).