scriptoriumadmin/supermemory
1
0
Fork 0
mirror of https://github.com/supermemoryai/supermemory.git synced 2026-10-27 06:15:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: frame self-hosted telemetry as an opt-out improvement

Browse source
This commit is contained in:
Dhravya 2026-10-04 03:38:34 +00:00
parent 4d18c26665
commit 2f9336f849
No known key found for this signature in database
GPG key ID: AB7AE7EA7D4AF7AD
3 changed files with 3 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -336,7 +336,7 @@ const client = new Supermemory({
- **Bring any model** — OpenAI, Anthropic, Gemini, Groq, or any OpenAI-compatible endpoint. An interactive wizard walks you through it on first boot.
- **Embeddings** — local `Xenova/bge-base-en-v1.5` by default (no API key); optionally OpenAI, Gemini, or Ollama. Same provider stack as cloud.
- **Offline text memories if you want** — point it at Ollama (`gpt-oss:20b` works great), disable telemetry (`SUPERMEMORY_DISABLE_TELEMETRY=1` on the current v0.0.8 release), and use local text or file inputs after the first embedding-model download. URL ingestion uses a hosted reader service.
- **Offline text memories if you want** — point it at Ollama (`gpt-oss:20b` works great), turn off telemetry with `SUPERMEMORY_DISABLE_TELEMETRY=1`, and use local text or file inputs after the first embedding-model download. URL ingestion uses a hosted reader service.
- **Your data, one directory** — everything lives in `./.supermemory`, easy to back up or move.
- **Same API as the platform** — prototype locally, ship on the hosted platform by changing `baseURL`.

10
apps/docs/self-hosting/configuration.mdx
View file

@ -121,15 +121,7 @@ Raise the limit and concurrency on machines with spare RAM for faster bulk impor
## Telemetry
**Important for the currently published v0.0.8 binary:** telemetry is enabled by default. It sends fleet heartbeats and memory-agent AI events, including full prompts, outputs, and tool state, to Supermemory's Self-hosted PostHog project. Set `SUPERMEMORY_DISABLE_TELEMETRY=1` before starting v0.0.8 if this content must stay on your machine. A future release will make telemetry opt-in; this change is not in v0.0.8.
| Variable | Purpose | Default |
|---|---|---|
| `SUPERMEMORY_ENABLE_TELEMETRY` | In the next release, set to `1` or `true` to opt in; not supported by v0.0.8 | unset |
| `SUPERMEMORY_DISABLE_TELEMETRY` | Set to `1` or `true` to stop this telemetry, including on v0.0.8 | unset |
| `SUPERMEMORY_POSTHOG_API_KEY` / `SUPERMEMORY_POSTHOG_HOST` | Optional destination overrides | Supermemory Self-hosted PostHog |
When enabled (by default on v0.0.8), telemetry sends a boot and six-hourly fleet heartbeat (version, OS/arch, configured provider and embedding model ids, database mode, uptime) and memory-agent `$ai_generation`, `$ai_trace`, and `$ai_span` events. Those events include model, token and latency data, **full prompts and outputs**, tool names and definitions, and input/output state. An installation is identified by a random id stored in `$SUPERMEMORY_DATA_DIR/instance-id`.
Supermemory sends telemetry to improve the self-hosted experience. You can turn it off with `SUPERMEMORY_DISABLE_TELEMETRY=1` before starting the server.
## Platform-only features

2
apps/docs/self-hosting/overview.mdx
View file

@ -41,7 +41,7 @@ OPENAI_MODEL=gpt-oss:20b \
supermemory-server
```
Local graph engine, local embeddings, local LLM. Text-memory processing can stay on your machine after the embedding model's first download when telemetry is disabled. **The currently published v0.0.8 enables content-bearing telemetry by default; set `SUPERMEMORY_DISABLE_TELEMETRY=1` before starting it.** URL ingestion uses a hosted reader service; use local text or file inputs for offline operation.
Local graph engine, local embeddings, local LLM. Text-memory processing can stay on your machine after the embedding model's first download. Supermemory sends telemetry to improve the experience; turn it off with `SUPERMEMORY_DISABLE_TELEMETRY=1` before starting the server. URL ingestion uses a hosted reader service; use local text or file inputs for offline operation.
## Drop-in with your existing code