Table of contents
=================

Introduction
------------

-  :doc:`Getting started </introduction/getting-started>`
-  :doc:`Frequently asked questions (FAQ) </introduction/faq>`
-  :doc:`Issue tracking </introduction/issue-tracking>`
-  :doc:`Help, support, mailing lists, and forum </introduction/support>`
-  :doc:`How to contribute </introduction/contributing>`

User Documentation
------------------

Core documentation for Qubes users.

Choosing Your Hardware
~~~~~~~~~~~~~~~~~~~~~~

-  :doc:`System requirements </user/hardware/system-requirements>`
-  :doc:`Certified hardware </user/hardware/certified-hardware>`
-  :doc:`Community-recommended
   hardware </user/hardware/community-recommended-hardware>`
-  :doc:`Hardware compatibility list (HCL) </user/hardware/hcl>`

Downloading, Installing, and Upgrading Qubes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  :doc:`Download Qubes OS </user/downloading-installing-upgrading/downloads>`
-  :doc:`Installation guide </user/downloading-installing-upgrading/installation-guide>`
-  :doc:`Upgrade guides </user/downloading-installing-upgrading/upgrade/upgrade>`
-  :doc:`Supported releases </user/downloading-installing-upgrading/supported-releases>`
-  :doc:`Testing new releases and updates </user/downloading-installing-upgrading/testing>`

How-to guides
~~~~~~~~~~~~~

-  :doc:`How to update </user/how-to-guides/how-to-update>`
-  :doc:`How to back up, restore, and
   migrate </user/how-to-guides/how-to-back-up-restore-and-migrate>`
-  :doc:`How to copy and paste text </user/how-to-guides/how-to-copy-and-paste-text>`
-  :doc:`How to copy and move files </user/how-to-guides/how-to-copy-and-move-files>`
-  :doc:`How to copy from dom0 </user/how-to-guides/how-to-copy-from-dom0>`
-  :doc:`How to install software </user/how-to-guides/how-to-install-software>`
-  :doc:`How to use disposables </user/how-to-guides/how-to-use-disposables>`
-  :doc:`How to enter fullscreen mode </user/how-to-guides/how-to-enter-fullscreen-mode>`
-  :doc:`How to use devices </user/how-to-guides/how-to-use-devices>`
-  :doc:`How to use block storage
   device </user/how-to-guides/how-to-use-block-storage-devices>`
-  :doc:`How to use USB devices </user/how-to-guides/how-to-use-usb-devices>`
-  :doc:`How to use PCI devices </user/how-to-guides/how-to-use-pci-devices>`
-  :doc:`How to use optical discs </user/how-to-guides/how-to-use-optical-discs>`

Templates
~~~~~~~~~

-  :doc:`Templates </user/templates/templates>`
-  :doc:`Fedora templates </user/templates/fedora/fedora>`
-  :doc:`Debian templates </user/templates/debian/debian>`
-  :doc:`Minimal templates </user/templates/minimal-templates>`
-  :doc:`Xfce templates </user/templates/xfce-templates>`

Troubleshooting
~~~~~~~~~~~~~~~

-  :doc:`Installation troubleshooting </user/troubleshooting/installation-troubleshooting>`
-  :doc:`Update troubleshooting </user/troubleshooting/update-troubleshooting>`
-  :doc:`Hardware troubleshooting </user/troubleshooting/hardware-troubleshooting>`
-  :doc:`UEFI troubleshooting </user/troubleshooting/uefi-troubleshooting>`
-  :doc:`Autostart troubleshooting </user/troubleshooting/autostart-troubleshooting>`
-  :doc:`Suspend/resume
   troubleshooting </user/troubleshooting/resume-suspend-troubleshooting>`
-  :doc:`App menu shortcut
   troubleshooting </user/troubleshooting/app-menu-shortcut-troubleshooting>`
-  :doc:`Qube troubleshooting </user/troubleshooting/vm-troubleshooting>`
-  :doc:`HVM troubleshooting </user/troubleshooting/hvm-troubleshooting>`
-  :doc:`Disk troubleshooting </user/troubleshooting/disk-troubleshooting>`
-  :doc:`PCI troubleshooting </user/troubleshooting/pci-troubleshooting>`
-  :doc:`USB troubleshooting </user/troubleshooting/usb-troubleshooting>`
-  :doc:`GUI troubleshooting </user/troubleshooting/gui-troubleshooting>`
-  :doc:`Media troubleshooting </user/troubleshooting/media-troubleshooting>`
-  :doc:`VPN troubleshooting </user/troubleshooting/vpn-troubleshooting>`

Security in Qubes
~~~~~~~~~~~~~~~~~

-  :doc:`Firewall </user/security-in-qubes/firewall>`
-  :doc:`Data leaks </user/security-in-qubes/data-leaks>`
-  :doc:`Passwordless root access in qubes </user/security-in-qubes/vm-sudo>`
-  :doc:`Device handling security </user/security-in-qubes/device-handling-security>`
-  :doc:`Anti evil maid (AEM) </user/security-in-qubes/anti-evil-maid>`
-  :doc:`Split GPG </user/security-in-qubes/split-gpg>`
-  :doc:`U2F proxy </user/security-in-qubes/u2f-proxy>`
-  :doc:`YubiKey </user/security-in-qubes/yubi-key>`

Advanced Configuration
~~~~~~~~~~~~~~~~~~~~~~

-  :doc:`How to install software in
   dom0 </user/advanced-topics/how-to-install-software-in-dom0>`
-  :doc:`Volume backup and revert </user/advanced-topics/volume-backup-revert>`
-  :doc:`Standalones and HVMs </user/advanced-topics/standalones-and-hvms>`
-  :doc:`Config files </user/advanced-topics/config-files>`
-  :doc:`Secondary storage </user/advanced-topics/secondary-storage>`
-  :doc:`RPC policies </user/advanced-topics/rpc-policy>`
-  :doc:`USB qubes </user/advanced-topics/usb-qubes>`
-  :doc:`Managing qube kernels </user/advanced-topics/managing-vm-kernels>`
-  :doc:`Salt (management software) </user/advanced-topics/salt>`
-  :doc:`GuiVM Configuration </user/advanced-topics/guivm>`
-  :doc:`Disposable customization </user/advanced-topics/disposable-customization>`
-  :doc:`Installing contributed
   packages </user/advanced-topics/installing-contributed-packages>`
-  :doc:`How to make any file persistent (bind-dirs) </user/advanced-topics/bind-dirs>`
-  :doc:`GUI configuration </user/advanced-topics/gui-configuration>`
-  :doc:`Resize disk images </user/advanced-topics/resize-disk-image>`
-  :doc:`Qubes service </user/advanced-topics/qubes-service>`
-  :doc:`How to mount a Qubes partition from another
   OS </user/advanced-topics/mount-from-other-os>`
-  :doc:`KDE (desktop environment) </user/advanced-topics/kde>`
-  :doc:`i3 (window manager) </user/advanced-topics/i3>`
-  :doc:`AwesomeWM (window manager) </user/advanced-topics/awesomewm>`

Reference
~~~~~~~~~

-  :doc:`Command-line tools </user/reference/tools>`
-  :doc:`Glossary </user/reference/glossary>`

Project Security
----------------

-  :doc:`Qubes OS project security center </project-security/security>`
-  :doc:`Qubes security pack (qubes-secpack) </project-security/security-pack>`
-  :doc:`Qubes security bulletins (QSBs) </project-security/qsb>`
-  :doc:`Qubes canaries </project-security/canary>`
-  :doc:`Xen security advisory (XSA) tracker </project-security/xsa>`
-  :doc:`Verifying signatures </project-security/verifying-signatures>`
-  `PGP keys <https://www.qubes-os.org/security/pgp-keys/>`__

Developer Documentation
-----------------------

Core documentation for Qubes developers and advanced users.

General
~~~~~~~

-  :doc:`Package contributions </developer/general/package-contributions>`
-  :doc:`Google Summer of Code (GSoC) </developer/general/gsoc>`
-  :doc:`Google Season of Docs (GSoD) </developer/general/gsod>`
-  :doc:`How to edit the
   documentation </developer/general/how-to-edit-the-documentation>`
-  :doc:`Documentation style guide </developer/general/documentation-style-guide>`
-  :doc:`Website style guide </developer/general/website-style-guide>`
-  :doc:`Continuous integration (CI) </developer/general/continuous-integration>`
-  :doc:`Usability & UX </developer/general/usability-ux>`
-  :doc:`Visual style guide </developer/general/visual-style-guide>`
-  :doc:`Research </developer/general/research>`
-  :doc:`Developer books </developer/general/devel-books>`

Code
~~~~

-  :doc:`Source code </developer/code/source-code>`
-  :doc:`Software license </developer/code/license>`
-  :doc:`Coding style </developer/code/coding-style>`
-  :doc:`Code signing </developer/code/code-signing>`

System
~~~~~~

-  :doc:`Architecture </developer/system/architecture>`
-  :doc:`Security design goals </developer/system/security-design-goals>`
-  :doc:`Security-critical code </developer/system/security-critical-code>`
-  :doc:`Qubes core admin </developer/system/qubes-core-admin>`
-  :doc:`Qubes core admin client </developer/system/qubes-core-admin-client>`
-  :doc:`Qubes core stack </developer/system/qubes-core-stack>`
-  :doc:`GUI virtualization </developer/system/gui>`
-  :doc:`Networking </developer/system/networking>`
-  :doc:`Template implementation </developer/system/template-implementation>`
-  :doc:`Storage pools </developer/system/storage-pools>`
-  :doc:`Audio virtualization </developer/system/audio>`
-  :doc:`Template manager </developer/system/template-manager>`

Services
~~~~~~~~

-  :doc:`Inter-qube file copying (qfilecopy) </developer/services/qfilecopy>`
-  :doc:`Qubes memory manager (qmemman) </developer/services/qmemman>`
-  :doc:`Dom0 secure updates </developer/services/dom0-secure-updates>`
-  :doc:`Qrexec: secure communication across domains </developer/services/qrexec>`
-  :doc:`Qrexec: Qubes RPC internals </developer/services/qrexec-internals>`
-  :doc:`Qrexec: Socket-based services </developer/services/qrexec-socket-services>`
-  :doc:`Admin API </developer/services/admin-api>`

Debugging
~~~~~~~~~

-  :doc:`How to set up a test bench </developer/debugging/test-bench>`
-  :doc:`Automated tests </developer/debugging/automated-tests>`
-  :doc:`Python profiling </developer/debugging/profiling>`
-  :doc:`Qube configuration interface </developer/debugging/vm-interface>`
-  :doc:`Windows debugging </developer/debugging/windows-debugging>`
-  :doc:`Safe remote dom0 terminals </developer/debugging/safe-remote-ttys>`
-  :doc:`How to mount LVM images </developer/debugging/mount-lvm-image>`

Building
~~~~~~~~

-  :doc:`Qubes builder </developer/building/qubes-builder>`
-  :doc:`Development workflow </developer/building/development-workflow>`
-  :doc:`Qubes ISO building </developer/building/qubes-iso-building>`
-  :doc:`Qubes template configs </developer/building/qubes-template-configs>`

Releases
~~~~~~~~

-  :doc:`Release notes </developer/releases/notes>`
-  :doc:`Release schedules </developer/releases/schedules>`
-  :doc:`Release checklist </developer/releases/todo>`
-  :doc:`Version scheme </developer/releases/version-scheme>`

External Documentation
----------------------

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

Operating System Guides
~~~~~~~~~~~~~~~~~~~~~~~

-  :doc:`Windows qubes </external/os-guides/windows/windows>`
-  `Template:
   Ubuntu <https://github.com/Qubes-Community/Contents/blob/master/docs/os/ubuntu.md>`__
-  `Template:
   Whonix <https://github.com/Qubes-Community/Contents/blob/master/docs/privacy/whonix.md>`__
-  `Template:
   CentOS <https://github.com/Qubes-Community/Contents/blob/master/docs/os/centos.md>`__
-  `Template:
   Gentoo <https://github.com/Qubes-Community/Contents/blob/master/docs/os/gentoo.md>`__
-  `Pentesting <https://github.com/Qubes-Community/Contents/blob/master/docs/os/pentesting.md>`__
-  `Pentesting:
   BlackArch <https://github.com/Qubes-Community/Contents/blob/master/docs/os/pentesting/blackarch.md>`__
-  `Pentesting:
   Kali <https://github.com/Qubes-Community/Contents/blob/master/docs/os/pentesting/kali.md>`__
-  `Pentesting:
   PTF <https://github.com/Qubes-Community/Contents/blob/master/docs/os/pentesting/ptf.md>`__
-  `Tips for Using Linux in an
   HVM <https://github.com/Qubes-Community/Contents/blob/master/docs/os/linux-hvm-tips.md>`__
-  `Creating a NetBSD
   VM <https://github.com/Qubes-Community/Contents/blob/master/docs/os/netbsd.md>`__

Security Guides
~~~~~~~~~~~~~~~

-  `Security
   Guidelines <https://github.com/Qubes-Community/Contents/blob/master/docs/security/security-guidelines.md>`__
-  `Using Multi-factor Authentication with
   Qubes <https://github.com/Qubes-Community/Contents/blob/master/docs/security/multifactor-authentication.md>`__
-  `How to Set Up a Split Bitcoin Wallet in
   Qubes <https://github.com/Qubes-Community/Contents/blob/master/docs/security/split-bitcoin.md>`__
-  `Split
   dm-crypt <https://github.com/rustybird/qubes-split-dm-crypt>`__
-  `Split
   SSH <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/split-ssh.md>`__
-  `Using OnlyKey with Qubes OS <https://docs.crp.to/qubes.html>`__

Privacy Guides
~~~~~~~~~~~~~~

-  `Whonix for Privacy &
   Anonymity <https://github.com/Qubes-Community/Contents/blob/master/docs/privacy/whonix.md>`__
-  `Running Tails in
   Qubes <https://github.com/Qubes-Community/Contents/blob/master/docs/privacy/tails.md>`__
-  `Anonymizing your MAC
   Address <https://github.com/Qubes-Community/Contents/blob/master/docs/privacy/anonymizing-your-mac-address.md>`__
-  `Signal <https://github.com/Qubes-Community/Contents/blob/master/docs/privacy/signal.md>`__
-  `Reducing the fingerprint of the text-based web browser
   w3m <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/w3m.md>`__

Configuration Guides
~~~~~~~~~~~~~~~~~~~~

-  `Qubes Tips and
   Tricks <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/tips-and-tricks.md>`__
-  `How to set up a ProxyVM as a VPN
   Gateway <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/vpn.md>`__
-  `Multibooting <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/multiboot.md>`__
-  `Changing your Time
   Zone <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/change-time-zone.md>`__
-  `Installing ZFS in
   Qubes <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/zfs.md>`__
-  `Mutt
   Guide <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/mutt.md>`__
-  `Postfix
   Guide <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/postfix.md>`__
-  `Fetchmail
   Guide <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/fetchmail.md>`__
-  `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>`__
-  `Adding Bridge Support to the NetVM
   (EXPERIMENTAL) <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/network-bridge-support.md>`__
-  `Screen
   Sharing <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/screen-share.md>`__
-  `Enabling TRIM for SSD
   disks <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/disk-trim.md>`__
-  `Configuring a Network
   Printer <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/network-printer.md>`__
-  `Using External Audio
   Devices <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/external-audio.md>`__
-  `Rxvt
   Guide <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/rxvt.md>`__
-  `Adding SSD storage
   cache <https://groups.google.com/d/msgid/qubes-users/a08359c9-9eb0-4d1a-ad92-a8a9bc676ea6%40googlegroups.com>`__
-  `How to Make a Multimedia
   TemplateVM <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/multimedia.md>`__
-  `How to install an Nvidia driver in
   dom0 <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/install-nvidia-driver.md>`__

Customization Guides
~~~~~~~~~~~~~~~~~~~~

-  `Customizing Fedora minimal
   templates <https://github.com/Qubes-Community/Contents/blob/master/docs/customization/fedora-minimal-template-customization.md>`__
-  `Customizing Windows 7
   templates <https://github.com/Qubes-Community/Contents/blob/master/docs/customization/windows-template-customization.md>`__
-  `Language
   Localization <https://github.com/Qubes-Community/Contents/blob/master/docs/customization/language-localization.md>`__
-  `Dark Theme in Dom0 and
   DomU <https://github.com/Qubes-Community/Contents/blob/master/docs/customization/dark-theme.md>`__
-  `Safely Removing TemplateVM Packages (Example:
   Thunderbird) <https://github.com/Qubes-Community/Contents/blob/master/docs/customization/removing-templatevm-packages.md>`__

.. _troubleshooting-1:

Troubleshooting
~~~~~~~~~~~~~~~

-  `Nvidia troubleshooting
   guide <https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/nvidia-troubleshooting.md>`__
-  `Lenovo ThinkPad
   Troubleshooting <https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/thinkpad-troubleshooting.md>`__
-  `Apple MacBook
   Troubleshooting <https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/macbook-troubleshooting.md>`__
-  `Sony Vaio
   Troubleshooting <https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/sony-vaio-tinkering.md>`__
-  `Intel Integrated Graphics
   Troubleshooting <https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/intel-igfx-troubleshooting.md>`__
-  `Multiboot
   Troubleshooting <https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/multiboot.md#troubleshooting>`__
-  `Application
   Troubleshooting <https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/application-troubleshooting.md>`__
-  `Tails
   Troubleshooting <https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/tails-troubleshooting.md>`__

Building Guides
~~~~~~~~~~~~~~~

-  `Building a TemplateVM based on a new OS (ArchLinux
   example) <https://github.com/Qubes-Community/Contents/blob/master/docs/building/building-non-fedora-template.md>`__
-  `Building the Archlinux
   Template <https://github.com/Qubes-Community/Contents/blob/master/docs/building/building-archlinux-template.md>`__
-  `Building the Whonix
   Templates <https://github.com/Qubes-Community/Contents/blob/master/docs/building/building-whonix-template.md>`__
-  `How to compile kernels for
   dom0 <https://groups.google.com/d/topic/qubes-users/yBeUJPwKwHM/discussion>`__