Documentation
The user manual is for developers and system administrators who want to build, run and deploy kayfabe. It describes what exists in the repository today and says so plainly where something does not exist yet.
Research stage. There is no installer, no stable interface and no security audit. Read Status: read this first before anything else.
Start here
Getting started
- Requirements What GPU, driver, kernel, QEMU and CPU the repository's evidence covers
- Building from source The exact steps the build scripts perform
- Running the QEMU device There is no installer: how the device is provisioned and started today, and its properties
Guests
- Linux guest Preparing and booting a Linux guest
- Windows guest The guest settings and the Windows harness
- Display and the broker Showing a guest's screen on the host
Reference
- Troubleshooting Symptoms that are documented in the repository
- Security model What is trusted, what is not, and what is unfinished
- Technical FAQ How it works and why it is designed this way
- Goals and plans What the project aims at later (other hypervisors, arm64, several GPUs in one guest), as goals with their status today
- Credits and notices Licences, trademarks, acknowledgements
FAQ
How to read the evidence labels
- [measured] means a run on named hardware at a named revision.
- [inferred] means reasoning, not a measurement.
- not documented yet means the repository does not state a verified answer. The manual does not guess.
- Every page ends with a Verified on line. Where the evidence does not cover a page end to end, it says Not verified end to end.
Versions
A version dropdown is at the top of every manual page.
Elsewhere
- Design and internals (GitHub): design documents, status records and evidence. They are for contributors, are not part of the manual and change faster than it does.
- Repository README: the landing text and current status.