Documentation

Table of contents

Introduction

• Getting started

• Frequently asked questions (FAQ)

• Issue tracking

• Help, support, mailing lists, and forum

• How to contribute

User Documentation

Core documentation for Qubes users.

Choosing Your Hardware

• System requirements

• Certified hardware

• Community-recommended hardware

• Hardware compatibility list (HCL)

Downloading, Installing, and Upgrading Qubes

• Download Qubes OS

• Installation guide

• Upgrade guides

• Supported releases

• Testing new releases and updates

How-to guides

• How to update

• How to back up, restore, and migrate

• How to copy and paste text

• How to copy and move files

• How to copy from dom0

• How to install software

• How to use disposables

• How to enter fullscreen mode

• How to use devices

• How to use block storage device

• How to use USB devices

• How to use PCI devices

• How to use optical discs

Templates

• Templates

• Fedora templates

• Debian templates

• Minimal templates

• Xfce templates

Troubleshooting

• Installation troubleshooting

• Update troubleshooting

• Update troubleshooting

• Hardware troubleshooting

• UEFI troubleshooting

• Autostart troubleshooting

• Suspend/resume troubleshooting

• App menu shortcut troubleshooting

• Qube troubleshooting

• HVM troubleshooting

• Disk troubleshooting

• PCI troubleshooting

• USB troubleshooting

• GUI troubleshooting

• Media troubleshooting

• VPN troubleshooting

Security in Qubes

• Firewall

• Data leaks

• Passwordless root access in qubes

• Device handling security

• Anti evil maid (AEM)

• Split GPG

• U2F proxy

• YubiKey

Advanced Configuration

• How to install software in dom0

• Volume backup and revert

• Standalones and HVMs

• Config files

• Secondary storage

• RPC policies

• USB qubes

• Managing qube kernels

• Salt (management software)

• GuiVM Configuration

• Disposable customization

• Installing contributed packages

• How to make any file persistent (bind-dirs)

• GUI configuration

• Resize disk images

• Qubes service

• How to mount a Qubes partition from another OS

• KDE (desktop environment)

• i3 (window manager)

• AwesomeWM (window manager)

Reference

• Command-line tools

• Glossary

Project Security

• Qubes OS project security center

• Qubes security pack (qubes-secpack)

• Qubes security bulletins (QSBs)

• Qubes canaries

• Xen security advisory (XSA) tracker

• Verifying signatures

• PGP keys

Developer Documentation

Core documentation for Qubes developers and advanced users.

General

• Package contributions

• Google Summer of Code (GSoC)

• Google Season of Docs (GSoD)

• How to edit the Markdown documentation

• How to edit the ReStructuredText documentation

• Markdown Documentation style guide

• Website style guide

• Continuous integration (CI)

• Usability & UX

• Visual style guide

• Research

• Developer books

Code

• Source code

• Software license

• Coding style

• Code signing

System

• Architecture

• Security design goals

• Security-critical code

• Qubes core admin

• Qubes core admin client

• Qubes core stack

• GUI virtualization

• Networking

• Template implementation

• Storage pools

• Audio virtualization

• Template manager

Services

• Inter-qube file copying (qfilecopy)

• Qubes memory manager (qmemman)

• Dom0 secure updates

• Qrexec: secure communication across domains

• Qrexec: Qubes RPC internals

• Qrexec: Socket-based services

• Admin API

Debugging

• How to set up a test bench

• Automated tests

• Python profiling

• Qube configuration interface

• Windows debugging

• Safe remote dom0 terminals

• How to mount LVM images

Building

• Qubes builder

• Development workflow

• Qubes ISO building

• Qubes template configs

Releases

• Release notes

• Release schedules

• Release checklist

• Version scheme

Hidden gems

• Qubes builder

• Join

• Admin API Table

• Disposable VM Implementation

• Qrexec2

• Qfileexchgd

• Code of Conduct

• Intro

• Privacy

• Screenshots

• Statistics

• Video Tours

• QSB Checklist

• Canary Checklist

• Download mirrors

• Custom install

• Install security

• How to use the hcl

• How to reinstall a template

• Debian template

• Debian upgrade

• Fedora upgrade

• Fedora

• Update Debian Whonix

External Documentation

Unofficial, third-party documentation from the Qubes community and others.

Operating System Guides

• Windows qubes

• Template: Ubuntu

• Template: Whonix

• Template: CentOS

• Template: Gentoo

• Pentesting

• Pentesting: BlackArch

• Pentesting: Kali

• Pentesting: PTF

• Tips for Using Linux in an HVM

• Creating a NetBSD VM

Security Guides

• Security Guidelines

• Using Multi-factor Authentication with Qubes

• How to Set Up a Split Bitcoin Wallet in Qubes

• Split dm-crypt

• Split SSH

• Using OnlyKey with Qubes OS

Privacy Guides

• Whonix for Privacy & Anonymity

• Running Tails in Qubes

• Anonymizing your MAC Address

• Signal

• Reducing the fingerprint of the text-based web browser w3m

Configuration Guides

• Qubes Tips and Tricks

• How to set up a ProxyVM as a VPN Gateway

• Multibooting

• Changing your Time Zone

• Installing ZFS in Qubes

• Mutt Guide

• Postfix Guide

• Fetchmail Guide

• Creating Custom NetVMs and ProxyVMs

• How to make proxy for individual tcp connection from networkless VM

• Adding Bridge Support to the NetVM (EXPERIMENTAL)

• Screen Sharing

• Enabling TRIM for SSD disks

• Configuring a Network Printer

• Using External Audio Devices

• Rxvt Guide

• Adding SSD storage cache

• How to Make a Multimedia TemplateVM

• How to install an Nvidia driver in dom0

Customization Guides

• Customizing Fedora minimal templates

• Customizing Windows 7 templates

• Language Localization

• Dark Theme in Dom0 and DomU

• Safely Removing TemplateVM Packages (Example: Thunderbird)

Troubleshooting

• Nvidia troubleshooting guide

• Lenovo ThinkPad Troubleshooting

• Apple MacBook Troubleshooting

• Sony Vaio Troubleshooting

• Intel Integrated Graphics Troubleshooting

• Multiboot Troubleshooting

• Application Troubleshooting

• Tails Troubleshooting

Building Guides

• Building a TemplateVM based on a new OS (ArchLinux example)

• Building the Archlinux Template

• Building the Whonix Templates

• How to compile kernels for dom0