User Documentation
The Basics
- What is Qubes OS?
- Video Tours
- Screenshots
- Getting Started
- User FAQ
- Help, Support, and Mailing Lists
- How to Contribute
Security Information
- Security Center
- Security FAQ
- Security Pack
- Security Bulletins
- Canaries
- Xen Security Advisory (XSA) Tracker
- Why and How to Verify Signatures
- Qubes PGP Keys
Choosing Your Hardware
Installing & Upgrading Qubes
- Qubes Downloads
- Qubes Download Mirrors
- Installation Guide
- Upgrade Guides
- Why and How to Verify Signatures
- Security Considerations when Installing
- Try Qubes without installing: Qubes Live USB (alpha)
- Supported Versions
- Version Scheme
- Custom Installation
- Testing new releases and updates
Common Tasks
- Copying and Pasting Text Between Domains
- Copying and Moving Files Between Domains
- Copying from (and to) dom0
- Installing and Updating Software in dom0
- Installing and Updating Software in VMs
- Backup, Restoration, and Migration
- Using DisposableVMs
- Block (or Storage) Devices
- USB Devices
- PCI Devices
- Device Handling
- Optical Discs
- Managing Application Shortcuts
- Enabling Fullscreen Mode
- Tips and Tricks
Managing Operating Systems within Qubes
- TemplateVMs
- Templates: Fedora
- Templates: Fedora Minimal
- Templates: Debian
- Templates: Debian Minimal
- Templates: Archlinux
- Templates: Ubuntu
- Templates: Whonix
- Pentesting
- Pentesting: BlackArch
- Pentesting: Kali
- Pentesting: PTF
- Windows
- Creating and Using HVM Domains
- Tips for Using Linux in an HVM
- Creating a NetBSD VM
- How to Reinstall a TemplateVM
Security Guides
- Qubes OS Project Security Information
- Security Guidelines
- Understanding Qubes Firewall
- Understanding and Preventing Data Leaks
- Installing Anti Evil Maid
- Using Multi-factor Authentication with Qubes
- Using GPG more securely in Qubes: Split GPG
- The Qubes U2F Proxy
- How to Set Up a Split Bitcoin Wallet in Qubes
- [Unofficial] Split dm-crypt
- Configuring YubiKey for user authentication
- Security Considerations When Handling Devices
- Note regarding password-less root access in VM
Privacy Guides
- Whonix for Privacy & Anonymity
- Running Tails in Qubes
- Anonymizing your MAC Address
- Martus
- Signal
- Reducing the fingerprint of the text-based web browser w3m
Configuration Guides
- Configuration Files
- How to set up a ProxyVM as a VPN Gateway
- Storing AppVMs on Secondary Drives
- Multibooting
- Resize Disk Image
- RPC Policies
- Changing your Time Zone
- GUI Configuration and Troubleshooting
- 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)
- USB Qubes
- Enabling TRIM for SSD disks
- Configuring a Network Printer
- Using External Audio Devices
- Rxvt Guide
- Managing VM kernel
- Salt management stack
- Adding SSD storage cache
- How to Make a Multimedia TemplateVM
Customization Guides
- DisposableVM Customization
- Customizing Fedora minimal templates
- Customizing Windows 7 templates
- Using KDE in dom0
- Installing i3 in dom0
- Using awesome in dom0
- Language Localization
- Dark Theme in Dom0 and DomU
- How to make any file in a TemplateBasedVM persistent using bind-dirs
- Safely Removing TemplateVM Packages (Example: Thunderbird)
Troubleshooting
- Home directory is out of disk space error
- Newer hardware doesn’t work
- Installing on system with new AMD GPU (missing firmware problem)
- How to install an Nvidia driver in dom0
- Nvidia troubleshooting guide
- Lenovo ThinkPad Troubleshooting
- Apple MacBook Troubleshooting
- Getting Sony Vaio Z laptop to work with Qubes
- Troubleshooting UEFI related problems
- Fixing wireless on suspend & resume
- How to remove VMs manually
- Intel Integrated Graphics Troubleshooting
Reference Pages
- Command-line tools
- Glossary of Qubes Terminology
- Qubes Service Framework
- Command Execution in VMs (and Qubes RPC)
- Deprecated documentation
Presentation Slides
- [PDF] LinuxCon 2014 – Qubes OS R2 Tutorial
- [PDF] LinuxCon 2014 – Qubes OS Keynote
- [PDF] RMLL 2016 – Improving client systems security with Qubes OS
- [PDF] Golem and Friends 2017 – Towards Reasonably Secure Computing in the Decentralized World
Developer Documentation
The Basics
- Developer FAQ
- Report a Security Issue
- Report a Bug
- How to Contribute
- Package Contributions
- Testing new releases and updates
- Source Code
- Qubes OS License
- Coding Guidelines
- Documentation Guidelines
- Code Signing
- Community-Developed Feature Tracker
- Google Summer of Code
- Google Season of Docs
- Books for Developers
- Style Guide
- Usability & UX
Security Information
- Security Center
- Security FAQ
- Security Pack
- Security Bulletins
- Security Bulletin Checklist
- Security Bulletin Template
- Canaries
- Canary Template
- Xen Security Advisory (XSA) Tracker
- Why and How to Verify Signatures
- Qubes PGP Keys
System
- Qubes OS Architecture Overview
- Qubes OS Architecture Spec v0.3 [PDF]
- Security-critical Code in Qubes OS
- Qubes Core Admin
- Qubes Core Admin Client
- Qubes Admin API
- Qubes Core Stack
- Qrexec: command execution in VMs
- 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
- Article about DisposableVMs
- Dom0 secure update mechanism
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
- Building Qubes (“API” Details)
- Development Workflow
- Building Qubes OS ISO
- Building Qubes Templates
- Building a TemplateVM based on a new OS (ArchLinux example)
- Building the Archlinux Template
- Building the Whonix Templates
- How to compile kernels for dom0