docs: surface telemetry controls for self-hosted deployments#421
Open
DivyamTalwar wants to merge 1 commit into
Open
docs: surface telemetry controls for self-hosted deployments#421DivyamTalwar wants to merge 1 commit into
DivyamTalwar wants to merge 1 commit into
Conversation
Self-hosted operators need telemetry controls before services start, and Docker-first users need accurate setup boundaries for env files, model providers, local auth bypass, database startup constraints, and bundled database defaults. Constraint: Keep this PR docs/template-comment-only; runtime hardening belongs in separate, tested changes. Rejected: Change auth, database credentials, telemetry persistence, Docker startup checks, or model defaults in this PR | those are runtime behavior changes outside the documentation scope. Confidence: high Scope-risk: narrow Directive: Preserve the distinction between the repo-clone development compose path and the installer/pre-built-image Docker path when editing these docs. Tested: content presence and stale-wording grep checks; Markdown render check; TOML/Bash fenced-snippet syntax check; Docker Compose config from a no-.env state using a temporary .env copy; Docker Compose TELEMETRY=false wiring for morphik and worker; git diff --check. Not-tested: hosted docs build; end-to-end model-provider startup.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Self-hosted telemetry is enabled by default, but the repository's self-hosting docs did not surface the existing
TELEMETRY=falseopt-out clearly before first start. This PR adds telemetry pointers in the README and Docker guide, expandsdocs/telemetry.mdwith the current telemetry behavior and caveats, and tightens Docker first-run guidance so operators understand the required.env, model-provider choice, and development-only defaults before starting services.Changes
.envfile before first start, with theTELEMETRY=falseopt-out shown before services start..env.exampleso Docker users know Compose injects the containerPOSTGRES_URI, while direct/local runs can use the template value.TELEMETRY=falseentry to.env.example../start-dev.shmounts the checked-in developmentmorphik.toml, auth bypass is enabled there, and model-backed operations need a Docker-reachable provider.OPENAI_API_KEY,http://ollama:11434, and the extraqwen2.5vl:latestpull needed by the checked-in Ollama vision selections..envexample to show environment-backed secrets and provider keys, while directing host, port, model, database, storage, and provider-selection settings tomorphik.toml.first_startheartbeat behavior, restart requirement for disabling telemetry, installation identifier durability, emitted identifiers/metadata, raw error-text behavior, upload/heartbeat/query endpoints,/logslocal/proxy boundaries, upload truncation, local retention limits, and the difference between the opt-out environment variable and[telemetry]tuning keys.Why this matters
Self-hosted operators should be able to find telemetry behavior and opt-out controls before starting services. Docker-first users should also see the first-run assumptions that materially affect privacy, auth, model configuration, and local-only safety.
Tests
Commands run:
rg -n 'Direct/local runs can set POSTGRES_URI|Docker Compose sets the container|registered_models|model = "openai_gpt4-1-mini"|model = "openai_embedding"|COMPOSE_PROFILES=ollama ./start-dev.sh --build|optional profiles for Ollama|qwen2\\.5vl:latest|rotated database users|image startup check|Non-local Deployment Checklist|JWT_SECRET_KEY` and `SESSION_SECRET_KEY|first successful heartbeat|retry with the `first_start` label|auth bypass is disabled and requests carry a real app scope|#self-hosting-morphik|#license|# TELEMETRY=false' README.md DOCKER.md docs/telemetry.md .env.exampledocs/telemetry.mdandDOCKER.md— passed..envDocker Compose check from a no-.envstate — passed. I verified that creating a temporary.envfrom.env.exampleletsdocker compose config --quietrender successfully, and cleanup restored the no-.envstate.TELEMETRY=falseappended to a temporary.env,docker compose configrenderedTELEMETRY: "false"for bothmorphikandworker.git diff --check origin/main...HEAD— passed.Not run:
docs/telemetry.md.Risk
Risk level: low
Docs/template-comment-only change. The wording is based on existing Docker Compose, config, auth, and telemetry code paths and does not change runtime configuration, telemetry payloads, auth behavior, database credentials, or defaults.
Issue
No existing issue. This was discovered during repository analysis.
Notes for maintainers
I intentionally avoided changing TOML sample configs, auth defaults, Docker database credentials, or telemetry persistence behavior in this PR. Those would be runtime changes and should be reviewed separately.