docs: make Docker the default pipeline path in the README quickstart - #100
Merged
Conversation
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.
Problem
The README quickstart still walked new users through the native toolchain — submodule init and a local nfdump build — even though the Docker path landed in #98. That is the most error-prone part of setup, and it was the first thing a newcomer hit.
Solution
The quickstart now uses
scripts/netflow-db-docker.shby default:git submodule update --init --recursiveand./vendor/scripts/compile-nfdump.sh; it is just clone plusbun install.--capture-root, and points out that the path is the same absoluteroot_pathfrom step 2 — the mount and the dataset config have to agree, which is the one thing that will bite people.Flows to exercise
Read the quickstart top to bottom as a new user with Docker installed and no Rust toolchain: steps 1 through 4 should complete without touching the native sections. The
--capture-rootvalue androot_pathindatasets.jsonmust be the same absolute path.Verification
bun run formatpasses. The#native-setupanchor resolves against the currentdocs/user/setup-pipeline.md. No behavior change — documentation only.The
docker builditself remains unverified on my host (no docker-group access), as noted in #98.Authored with Claude Code (Fable 5).