qubes-doc/doc.md

---
layout: doc-index
title: Documentation
permalink: /doc/
redirect_from:
- /en/doc/
- /doc/UserDoc/
- /wiki/UserDoc/
- /doc/QubesDocs/
- /wiki/QubesDocs/
- /help/
- /en/help/
- /en/community/
- /community/
---

User Documentation
==================

The Basics
----------
 * [What is Qubes OS?](/intro/)
 * [Video Tours](/video-tours/)
 * [Screenshots](/screenshots/)
 * [Getting Started](/getting-started/)
 * [User FAQ](/faq/#users)
 * [Mailing Lists](/mailing-lists/)
 * [How to Contribute](/doc/contributing/)

Security Information
--------------------
 * [Security Center](/security/)
 * [Security FAQ](/faq/#general--security)
 * [Security Pack](/security/pack/)
 * [Security Bulletins](/security/bulletins/)
 * [Canaries](/security/canaries/)
 * [Xen Security Advisory (XSA) Tracker](/security/xsa/)
 * [Why and How to Verify Signatures](/security/verifying-signatures/)
 * [Qubes PGP Keys](https://keys.qubes-os.org/keys/)

Choosing Your Hardware
----------------------
 * [System Requirements](/doc/system-requirements/)
 * [Certified Hardware](/doc/certified-hardware/)
 * [Hardware Compatibility List (HCL)](/hcl/)

Installing & Upgrading Qubes
----------------------------
 * [Qubes Downloads](/downloads/)
 * [Qubes Download Mirrors](/downloads/mirrors/)
 * [Installation Guide](/doc/installation-guide/)
 * [Upgrade Guides](/doc/upgrade/)
 * [Why and How to Verify Signatures](/security/verifying-signatures/)
 * [Security Considerations when Installing](/doc/install-security/)
 * [Try Qubes without installing: Qubes Live USB (alpha)](/doc/live-usb/)
 * [Supported Versions](/doc/supported-versions/)
 * [Version Scheme](/doc/version-scheme/)
 * [Custom Installation](/doc/custom-install/)
 * [Testing new releases and updates](/doc/testing/)

Common Tasks
------------
 * [Copying and Pasting Text Between Domains](/doc/copy-paste/)
 * [Copying and Moving Files Between Domains](/doc/copying-files/)
 * [Copying from (and to) dom0](/doc/copy-from-dom0/)
 * [Updating Software in dom0](/doc/software-update-dom0/)
 * [Updating and Installing Software in VMs](/doc/software-update-vm/)
 * [Backup, Restoration, and Migration](/doc/backup-restore/)
 * [Using Disposable VMs](/doc/dispvm/)
 * [Using and Managing USB Devices](/doc/usb/)
 * [Recording Optical Discs](/doc/recording-optical-discs/)
 * [Managing Application Shortcuts](/doc/managing-appvm-shortcuts/)
 * [Enabling Fullscreen Mode](/doc/full-screen-mode/)
 * [Tips and Tricks](/doc/tips-and-tricks/)

Managing Operating Systems within Qubes
---------------------------------------
 * [TemplateVMs](/doc/templates/)
 * [Templates: Fedora](/doc/templates/fedora/)
 * [Templates: Fedora Minimal](/doc/templates/fedora-minimal/)
 * [Templates: Debian](/doc/templates/debian/)
 * [Templates: Archlinux](/doc/templates/archlinux/)
 * [Templates: Ubuntu](/doc/templates/ubuntu/)
 * [Templates: Whonix](/doc/whonix/)
 * [Pentesting](/doc/pentesting/)
 * [Pentesting: BlackArch](/doc/pentesting/blackarch/)
 * [Pentesting: Kali](/doc/pentesting/kali/)
 * [Pentesting: PTF](/doc/pentesting/ptf/)
 * [Windows](/doc/windows/)
 * [Creating and Using HVM Domains](/doc/hvm/)
 * [Tips for Using Linux in an HVM](/doc/linux-hvm-tips/)
 * [Creating a NetBSD VM](/doc/netbsd/)
 * [How to Reinstall a TemplateVM](/doc/reinstall-template)


Security Guides
---------------
 * [Qubes OS Project Security Information](/security/)
 * [Security Guidelines](/doc/security-guidelines/)
 * [Understanding Qubes Firewall](/doc/firewall/)
 * [Understanding and Preventing Data Leaks](/doc/data-leaks/)
 * [Installing Anti Evil Maid](/doc/anti-evil-maid/)
 * [Using Multi-factor Authentication with Qubes](/doc/multifactor-authentication/)
 * [Using GPG more securely in Qubes: Split GPG](/doc/split-gpg/)
 * [How to Set Up a Split Bitcoin Wallet in Qubes](/doc/split-bitcoin/)
 * [[Unofficial] Split dm-crypt](https://github.com/rustybird/qubes-split-dm-crypt)
 * [Configuring YubiKey for user authentication](/doc/yubi-key/)
 * [Note regarding password-less root access in VM](/doc/vm-sudo/)


Privacy Guides
--------------
 * [Whonix for Privacy & Anonymity](/doc/whonix/)
 * [Running Tails in Qubes](/doc/tails/)
 * [Anonymizing your MAC Address](/doc/anonymizing-your-mac-address/)
 * [Martus](/doc/martus/)
 * [Signal](/doc/signal/)
 * [Reducing the fingerprint of the text-based web browser w3m](/doc/w3m/)


Configuration Guides
--------------------
 * [Configuration Files](/doc/config-files/)
 * [How to set up a ProxyVM as a VPN Gateway](/doc/vpn/)
 * [Storing AppVMs on Secondary Drives](/doc/secondary-storage/)
 * [Multibooting](/doc/multiboot/)
 * [Resize Disk Image](/doc/resize-disk-image/)
 * [RPC Policies](/doc/rpc-policy/)
 * [Installing ZFS in Qubes](/doc/zfs/)
 * [Mutt Guide](/doc/mutt/)
 * [Postfix Guide](/doc/postfix/)
 * [Fetchmail Guide](/doc/fetchmail/)
 * [Creating Custom NetVMs and ProxyVMs](https://theinvisiblethings.blogspot.com/2011/09/playing-with-qubes-networking-for-fun.html)
 * [How to make proxy for individual tcp connection from networkless VM](https://groups.google.com/group/qubes-devel/msg/4ca950ab6d7cd11a)
 * [Make an HTTP Filtering Proxy in a FirewallVM](/doc/config/http-filtering-proxy)
 * [Adding Bridge Support to the NetVM (EXPERIMENTAL)](/doc/network-bridge-support/)
 * [Assigning PCI Devices to AppVMs](/doc/assigning-devices/)
 * [Enabling TRIM for SSD disks](/doc/disk-trim/)
 * [Configuring a Network Printer](/doc/network-printer/)
 * [Using External Audio Devices](/doc/external-audio/)
 * [Rxvt Guide](/doc/rxvt/)
 * [Managing VM kernel](/doc/managing-vm-kernel/)
 * [Salt management stack](/doc/salt/)
 * [Adding SSD storage cache](https://groups.google.com/d/msgid/qubes-users/a08359c9-9eb0-4d1a-ad92-a8a9bc676ea6%40googlegroups.com)


Customization Guides
--------------------
 * [DispVM Customization](/doc/dispvm-customization/)
 * [Customizing Fedora minimal templates](/doc/fedora-minimal-template-customization)
 * [Customizing Windows 7 templates](/doc/windows-template-customization)
 * [Using KDE in dom0](/doc/kde/)
 * [Installing XFCE in dom0](/doc/xfce/)
 * [Installing i3 in dom0](/doc/i3/)
 * [Language Localization](/doc/language-localization/)
 * [Dark Theme in Dom0 and DomU](/doc/dark-theme/)
 * [How to make any file in a TemplateBasedVM persistent using bind-dirs](/doc/bind-dirs/)


Troubleshooting
---------------
 * [Home directory is out of disk space error](/doc/out-of-memory/)
 * [Installing on system with new AMD GPU (missing firmware problem)](https://groups.google.com/group/qubes-devel/browse_thread/thread/e27a57b0eda62f76)
 * [How to install an Nvidia driver in dom0](/doc/install-nvidia-driver/)
 * [Nvidia troubleshooting guide](/doc/nvidia-troubleshooting/)
 * [Lenovo ThinkPad Troubleshooting](/doc/thinkpad-troubleshooting/)
 * [Apple MacBook Troubleshooting](/doc/macbook-troubleshooting/)
 * [Getting Sony Vaio Z laptop to work with Qubes](/doc/sony-vaio-tinkering/)
 * [Troubleshooting UEFI related problems](/doc/uefi-troubleshooting/)
 * [Fixing wireless on suspend & resume](/doc/wireless-troubleshooting/)
 * [How to remove VMs manually](/doc/remove-vm-manually/)
 * [Intel Integrated Graphics Troubleshooting](/doc/intel-igfx-troubleshooting/)


Reference Pages
---------------
 * [Command-Line Tools: Qubes 3.2, dom0](/doc/tools/3.2/dom0/)
 * [Command-Line Tools: Qubes 3.2, domU](/doc/tools/3.2/domU/)
 * [Command-Line Tools: Qubes 4.0, dom0](/doc/tools/4.0/dom0/)
 * [Command-Line Tools: Qubes 4.0, domU](/doc/tools/4.0/domU/)
 * [Glossary of Qubes Terminology](/doc/glossary/)
 * [Qubes Service Framework](/doc/qubes-service/)
 * [Command Execution in VMs (and Qubes RPC)](/doc/qrexec/)


Presentation Slides
-------------------
 * [[PDF] LinuxCon 2014 -- Qubes OS R2 Tutorial](/attachment/wiki/slides/LinuxCon_2014_Qubes_Tutorial.pdf)
 * [[PDF] LinuxCon 2014 -- Qubes OS Keynote](/attachment/wiki/slides/LinuxCon_2014_Qubes_Keynote.pdf)
 * [[PDF] RMLL 2016 -- Improving client systems security with Qubes OS](/attachment/wiki/slides/RMLL_2016_Improving-client-systems-security.pdf)
 * [[PDF] Golem and Friends 2017 -- Towards Reasonably Secure Computing in the Decentralized World](/attachment/wiki/slides/Secure_Computing_in_Decentralized_World.pdf)

Developer Documentation
=======================

The Basics
----------
 * [Developer FAQ](/faq/#developers)
 * [Report a Security Issue](/security/)
 * [Report a Bug](/doc/reporting-bugs/)
 * [How to Contribute](/doc/contributing/)
 * [Package Contributions](/doc/package-contributions/)
 * [Testing new releases and updates](/doc/testing/)
 * [Source Code](/doc/source-code/)
 * [Qubes OS License](/doc/license/)
 * [Coding Guidelines](/doc/coding-style/)
 * [Documentation Guidelines](/doc/doc-guidelines/)
 * [Code Signing](/doc/code-signing/)
 * [Community-Developed Feature Tracker](/qubes-issues/)
 * [Books for Developers](/doc/devel-books/)
 * [Style Guide](/doc/style-guide/)
 * [Usability & UX](/doc/usability-ux/)

Security Information
--------------------
 * [Security Center](/security/)
 * [Security FAQ](/faq/#general--security)
 * [Security Pack](/security/pack/)
 * [Security Bulletins](/security/bulletins/)
 * [Security Bulletin Checklist](/security/bulletins/checklist/)
 * [Security Bulletin Template](/security/bulletins/template/)
 * [Canaries](/security/canaries/)
 * [Canary Template](/security/canaries/template/)
 * [Xen Security Advisory (XSA) Tracker](/security/xsa/)
 * [Why and How to Verify Signatures](/security/verifying-signatures/)
 * [Qubes PGP Keys](http://keys.qubes-os.org/keys/)

System
------
 * [Qubes OS Architecture Overview](/doc/architecture/)
 * [Qubes OS Architecture Spec v0.3 [PDF]](/attachment/wiki/QubesArchitecture/arch-spec-0.3.pdf)
 * [Security-critical elements of Qubes OS](/doc/security-critical-code/)
 * [Qubes Core Admin](https://dev.qubes-os.org/projects/core-admin/en/latest/)
 * [Qubes Core Admin Client](https://dev.qubes-os.org/projects/core-admin-client/en/latest/)
 * [Qubes Admin API](/news/2017/06/27/qubes-admin-api/)
 * [Qubes Core Stack](/news/2017/10/03/core3/)
 * [Qrexec: command execution in VMs](/doc/qrexec3/)
 * [Qubes GUI virtualization protocol](/doc/gui/)
 * [Networking in Qubes](/doc/networking/)
 * [Implementation of template sharing and updating](/doc/template-implementation/)
 * [Storage Pools](/doc/storage-pools/)

Services
--------
 * [Inter-domain file copying](/doc/qfilecopy/) (deprecates [`qfileexchgd`](/doc/qfileexchgd/))
 * [Dynamic memory management in Qubes](/doc/qmemman/)
 * [Implementation of DisposableVMs](/doc/dvm-impl/)
 * [Article about disposable VMs](http://theinvisiblethings.blogspot.com/2010/06/disposable-vms.html)
 * [Dom0 secure update mechanism](/doc/dom0-secure-updates/)

Debugging
---------
 * [Profiling python code](/doc/profiling/)
 * [Test environment in separate machine for automatic tests](/doc/test-bench/)
 * [Automated tests](/doc/automated-tests/)
 * [VM-dom0 internal configuration interface](/doc/vm-interface/)
 * [Debugging Windows VMs](/doc/windows-debugging/)
 * [Safe Remote Dom0 Terminals](/doc/safe-remote-ttys/)

Building
--------
 * [Building Qubes](/doc/qubes-builder/) (["API" Details](/doc/qubes-builder-details/))
 * [Development Workflow](/doc/development-workflow/)
 * [Building Qubes OS 3.0 ISO](/doc/qubes-r3-building/)
 * [Building Qubes Templates](https://github.com/QubesOS/qubes-template-configs)
 * [Building a TemplateVM based on a new OS (ArchLinux example)](/doc/building-non-fedora-template/)
 * [Building the Archlinux Template](/doc/building-archlinux-template/)
 * [How to compile kernels for dom0](https://groups.google.com/d/topic/qubes-users/yBeUJPwKwHM/discussion)

Releases
--------
 * [Release notes](/doc/releases/notes/)
 * [Release schedules](/doc/releases/schedules/)
 * [Release checklist](/doc/releases/todo/)