docs(onboarding): make deploy/compose the primary onboarding path - #126
waterbro-8 wants to merge 1 commit into
Conversation
…evelopment-only Ops dogfood showed the container path is the shortest time-to-value while the bare-metal stack requires a Homebrew PostgreSQL layout that Linux and WSL2 hosts do not satisfy. README now opens with the verified compose closed loop, states the local-fast-v2 model-stage boundaries, and gives a platform-equivalent route for every development step; RUN_LOCAL gains the same equivalences plus a dependency-container path for non-Homebrew hosts.
Draft audit at
|
PeterGuy326
left a comment
There was a problem hiding this comment.
Review status: HOLD, not an approval. The draft is conflicted with current main; more importantly, canonical Issue #109 remains R1 needs-design and the stated AC-002 clean-environment onboarding closure is not yet evidenced. Existing green checks do not substitute for those prerequisites.
Please preserve Draft status, establish the ready requirement/decision and complete the clean-environment acceptance evidence first, then synchronize to current main and rerun the exact-head checks before requesting a final review.
|
ByteFolk cutover blocker (exact head
Please update the fork branch and rerun CI before merge. |
|
Closing this dirty draft under bytefolk/.github#24 AC-004. The requirement remains in #109 R2, and #148 is the newer implementation candidate. This closure is not acceptance of #148: the replacement still needs a clean final tree, the required clean-host Compose evidence, fresh CI, and independent review before merge. No requirement or historical evidence is deleted. |
What changed
README.mdpresents
deploy/composeas the primary path (generate-env.sh→config --quiet→up -d --build --wait→ first-user registration →folder creation), matching the canonical sequence in
docs/DEPLOYMENT.md.into a pinned table (
server/go.mod,worker/uv.lock,web/package-lock.json), plus a 依赖服务的平台等价 matrix giving theWSL2/Linux equivalent for every Homebrew-leaning step.
running instance instead of implying
scripts/dev_up.shis the entry point.The bare-metal path is preserved, not deleted.
local-fast-v2, with the reason (see scope note below)."develop" to the right file.
docs/RUN_LOCAL.md进程应用 route for apt-based hosts (
dev_up.shonly discovers Homebrew kegs).conditions for Ollama.
CHANGELOG.md—[Unreleased]Added + Changed entries.Refs #109
Scope note on the model boundary
An earlier local draft claimed "Worker 模型默认值全为空". That is wrong and is not
in this PR:
worker/mem_worker/config.py:116-123does ship non-emptyMEM_DEFAULT_*values. The accurate statement is per-profile and per-stage —server/internal/aiprofile/catalog.go:347-371enables only text embedding(
ollama:qwen3-embedding:0.6b, 768 dims) with a text/PDF MIME allow-list andleaves
VisualEmbedding,LLM,VLM,ASRandRerankas empty stages,while
deploy/compose/compose.yamlkeepsbackendinternal and points theworker's
OLLAMA_BASE_URLat its own127.0.0.1:11434. The docs now say that.Validation ledger
webpublishes a host port;backendis internalawkscan overdeploy/compose/compose.yaml→web: HAS portsis the only hit;networks.backend.internal: true; MinIO pinRELEASE.2025-04-22T22-12-26Z, imagespgvector/pgvector:0.8.1-pg16,redis:7.4.2-alpinegenerate-env.shclaimsopenssldeploy/compose/generate-env.sh:4-11([ -e "$output" ]→ exit 1,openssl is required),:14umask 077,:39reports mode 0600first_usercompose.yaml:21,.env.example:6docs/DEPLOYMENT.mdDEPLOYMENT.md:105— 4 vCPU / 8 GiB / 80 GiB model-freedev_up.shcross-platform claimssetsidon Linux,vector.so/vector.dylib,@17/@18/@16autodetectscripts/dev_up.sh:29-36,:96-114,:127-134; "kept in sync with server/.env.example + worker/.env.example" at:38:5432, Redis host:6479, MinIO host:9100,memd/workercommented outdocker-compose.yml:8-101server/.env.exampleRedis defaultserver/.env.example:17MEM_REDIS_URL=worker/.envworker/mem_worker/config.py:41env_file=".env"server/internal/aiprofile/service.go:389-395(ErrEmbeddingProbeFailed/ErrEmbeddingDimensionMismatch), surfaced as 422ai_profile_embedding_dimension_mismatchatserver/internal/api/handlers_ai_profile.go:92## 开始使用exists and is the only#开始使用target (docs/RUN_LOCAL.md:4); repo-wide grep for快速开始finds onlyweb/README.md's own headingmaine6f082b(#118); upstream touched onlyCHANGELOG.mdin these paths since the old base, no conflictNot run, and deliberately not claimed:
on a fresh host for this PR. The closed-loop statement in the README is
attributed to the ops dogfood record in docs(onboarding): make deploy/compose the primary onboarding path #109 rather than presented as
first-party evidence from this change.
make lint,make test-allandthe protobuf regeneration checks were not run locally; CI covers them.
Rollback
Revert
3668d41. Documentation-only: no runtime, schema, compose topology orrelease-artifact impact, so no data migration or cache invalidation is implied.
Governance gate — this PR should not merge yet
Per
AGENTS.mdrule 2, implementation waits for acceptance criteria and thestatus:readylabel. #109 has AC-001..003 but is stillR1 status: needs-designwith
technicalOwner: unassigned, so this is opened as a draft for earlyfeedback (org
CONTRIBUTING.md: drafts are welcome, not merge-eligible).status:ready(R2), or amend therequirements if the container-first framing is not what you want.
belongs in a shared
mem doctorsurface is being tracked in feat(cli): add mem doctor and first-run guidance that names the documented deploy/compose path #112; feat(cli): add mem doctor and first-run guidance that names the documented deploy/compose path #112 is alsostill
needs-design, so the two should be adjudicated together.