Qubes OS Documentation

Welcome to the Qubes OS documentation!

Introduction

  • What is Qubes OS?

  • Video Tours

  • Screenshots

  • User FAQ

  • Reporting Bugs and Other Issues

  • Help, Support, Mailing Lists, and Forum

  • How to Contribute

Project Security

  • Security Center

  • Security FAQ

  • Security Pack

  • Security Bulletins

  • Canaries

  • Xen Security Advisory (XSA) Tracker

  • Verifying Signatures

  • Qubes PGP Keys

User Documentation

Core documentation for Qubes users.

Choosing Your Hardware

  • System Requirements

  • Certified Hardware

  • Hardware Compatibility List (HCL)

  • Hardware Testing

Downloading, Installing, and Upgrading Qubes

  • Downloads

  • Installation Guide

  • Upgrade Guides

  • Supported Versions

  • Version Scheme

  • Testing New Releases and Updates

Common Tasks

  • Getting Started

  • Copying and Pasting Text Between Domains

  • Copying and Moving Files Between Domains

  • Copying from (and to) Dom0

  • Updating Qubes OS

  • Installing and Updating Software in Dom0

  • Installing and Updating Software in DomUs

  • Backup, Restoration, and Migration

  • Volume Backup and Revert

  • DisposableVMs

  • Block (or Storage) Devices

  • USB Devices

  • PCI Devices

  • Device Handling

  • Optical Discs

  • Fullscreen Mode

Managing Operating Systems within Qubes

  • TemplateVMs

  • Fedora

  • Debian

  • Minimal TemplateVMs

  • Windows

  • StandaloneVMs and HVMs

Security in Qubes

  • Qubes Firewall

  • Understanding and Preventing Data Leaks

  • Passwordless Root Access in VMs

  • Device Handling Security

  • Anti Evil Maid

  • Split GPG

  • U2F Proxy

  • YubiKey

Advanced Configuration

  • Configuration Files

  • Storing AppVMs on Secondary Drives

  • RPC Policies

  • USB Qubes

  • Managing VM Kernels

  • Salt Management Stack

  • DisposableVM Customization

  • Making Any File Persistent Using bind-dirs

  • GUI Configuration

  • Resizing Disk Images

  • Mounting and Decrypting Qubes Partitions from Outside Qubes

  • KDE

  • i3 Window Manager

  • awesome Window Manager

Troubleshooting

  • Installation Troubleshooting

  • UEFI Troubleshooting

  • Suspend/Resume Troubleshooting

  • Application Shortcut Troubleshooting

  • VM Troubleshooting

  • HVM Troubleshooting

  • Disk Troubleshooting

  • PCI Troubleshooting

  • USB Troubleshooting

  • GUI Troubleshooting

  • Media Troubleshooting

  • Firewall Troubleshooting

  • Hardware Troubleshooting

  • VPN Troubleshooting

  • Update Troubleshooting

Reference Pages

Developer Documentation

Core documentation for Qubes developers and advanced users.

General

  • Developer FAQ

  • Package Contributions

  • Documentation Guidelines

  • Community-Developed Feature Tracker

  • Google Summer of Code

  • Google Season of Docs

  • Books for Developers

  • Style Guide

  • Usability & UX

Code

  • Source Code

  • Software License

  • Coding Guidelines

  • Code Signing

System

  • Qubes OS Architecture Overview

  • Security-critical Code in Qubes OS

  • Qubes Core Admin

  • Qubes Core Admin Client

  • Qubes Admin API

  • Qubes Core Stack

  • Qubes GUI virtualization protocol

  • Networking in Qubes

  • Implementation of template sharing and updating

  • Storage Pools

  • Audio virtualization

Services

  • Inter-domain file copying (deprecates qfileexchgd)

  • Dynamic memory management in Qubes

  • Implementation of DisposableVMs

  • Dom0 secure update mechanism

  • Qrexec: secure communication across domains

  • Qrexec: Qubes RPC internals

  • Qrexec: Socket-based services

Debugging

  • Profiling python code

  • Test environment in separate machine for automatic tests

  • Automated tests

  • VM-dom0 internal configuration interface

  • Debugging Windows VMs

  • Safe Remote Dom0 Terminals

  • Mount LVM Image

Building

Releases

  • Release notes

  • Release schedules

  • Release checklist

External Documentation

Unofficial, third-party documentation from the Qubes community and others. For more, please see Qubes Community Documentation.

Operating System Guides

Security Guides

Privacy Guides

Configuration Guides

Customization Guides

Troubleshooting

Building Guides