The Xen Project Wiki is the primary source for documentation of the Xen Project software.
Related documentation in many Linux/Unix distributions can also be found on 3rd party websites and blogs.
Start here – this guide will help you navigate the wiki.
- Index Pages
- Help Contents
- User Categories
Documentation for XenServer (Citrix Hypervisor) and its deprecated sibling XCP, is not stored on the Xen Project Wiki.
Documentation for XCP’s successor XCP-ng is stored on its own GitHub Wiki.
Xen Project Hypervisor
The Xen Project Hypervisor team generates main pages, support statements, feature specifications, interface documentation, and other documentation from the source tree.
Source generated documentation can’t be found on xenbits.xenproject.org/docs. Most documentation is organized by release.
- x.y-testing contains the documentation for the x,.y releases, and maintenance releases (e.g. 4.11-testing)
- unstable contains the documentation for the unstable development tree
- unstable-staging contains the documentation for the staging development tree
Over time, the documentation in the Xen tree has become rather unwieldy. We have created a new sphinx docset to help address this.
- sphinx-x.y-testing.new contains the documentation for the x,.y releases, and maintenance releases (e.g. sphinx-4.13-testing.new)
- sphinx-unstable contains the documentation for the unstable development tree
- sphinx-unstable-staging contains the documentation for the staging development tree
In addition, there are a number of test related resources:
- docs/xtf contains the API documentation for microkernel-based tests and descriptions of tests built using the XTF framework
- logs.test-lab.xenproject.org/osstest contains logs for our Test Lab. Also, see osstest-output@ for e-mail based test result reporting.
- GitLab CI Pipelines contains the user-facing portions of our GitLab CI
The XCP-ng project has a complete documentation set and is open for contribution.
For other project-specific documentation. please check the respective Team Portal
Contribute to the Wiki
The Xen Project Wiki is open to everyone.
However, subject to spam attacks a simple procedure has been put in place to grant access. Follow the instructions below to create a wiki account with write access:
- Create an account and log in
- Become an editor (this is new and may take a couple of hours)
- Read the Wiki Guide
- Play with the Sandbox
Search Xen Project Mailing Lists
All Xen Project mailing lists are archived here. Often you will find answers by searching these.
Due to issues with markmail, we recommend going here for Xen-Devel archives.