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

@@ -87,7 +87,8 @@ sha256sum Waggle_<version>_amd64.deb
The window shows "Starting Waggle…" while the app starts its own server in the background. The
server listens on `127.0.0.1` port 3333, or on another free port if 3333 is taken. Its log is in
`~/.waggle/logs/service.log` (on Windows `%USERPROFILE%\.waggle\logs\service.log`).
`~/.waggle-community/logs/service.log` (on Windows
`%USERPROFILE%\.waggle-community\logs\service.log`).
### Update the desktop app
@@ -168,7 +169,7 @@ it. It listens on this computer only (`127.0.0.1`).
|---|---|
| `--port <number>`, `-p` | Use another port (default 3333) |
| `--no-open` | Do not open the browser |
| `--data-dir <path>` | Keep data in another directory (default `$WAGGLE_DATA_DIR` or `~/.waggle`) |
| `--data-dir <path>` | Keep data in another directory (default `$WAGGLE_DATA_DIR` or `~/.waggle-community`) |
| `--dir <path>` | Use a program directory other than the default |
If Waggle already runs on the port, `waggle-server` only opens the browser.
@@ -244,9 +245,15 @@ send.
## Where your data lives
Both ways of installing use one data directory: `~/.waggle` (on Windows
`%USERPROFILE%\.waggle`). Set `WAGGLE_DATA_DIR` to use another directory; the server installer
also takes `--data-dir`.
Both ways of installing use one data directory: `~/.waggle-community` (on Windows
`%USERPROFILE%\.waggle-community`). Set `WAGGLE_DATA_DIR` to use another directory; the server
installer also takes `--data-dir`.
The community edition does not touch `~/.waggle`, the data directory of the commercial Waggle,
unless you point `WAGGLE_DATA_DIR` at it, so the two editions do not read or write each other's
databases. Nothing is copied from
`~/.waggle`: the community edition starts with an empty data directory. The directory name is
temporary until the product name is decided.
| Path in the data directory | What it holds |
|---|---|