Skip to content

docs(readme): doctor runs 17 checks, not 16 #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WaylandYang merged 1 commit into from
Jun 14, 2026
Merged

docs(readme): doctor runs 17 checks, not 16 #246

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,12 +481,12 @@ pip install forkd # Python SDK — calls the daemon over
npm install @deeplethe/forkd # TypeScript SDK
```

`forkd doctor` runs 16 checks (KVM, hardware virt, cgroup v2, IP forward,
`forkd doctor` runs 17 checks (KVM, hardware virt, cgroup v2, IP forward,
tap, netns, Firecracker binary + version, Docker daemon, snapshot dir +
disk space, kernel image, controller reachability, platform, plus
`uffd_wp` + `memfd_create` for the v0.4 live-fork path) and emits
specific fix hints for each non-pass. Run this first whenever something
feels off.
`uffd_wp` + `memfd_create` + hugepages for the v0.4 live-fork path) and
emits specific fix hints for each non-pass. Run this first whenever
something feels off.

![forkd doctor — 14 checks pass on a configured host](./docs/assets/doctor-14pass.webp)

Expand Down
Loading