Merge branch 'auto-gen'

This commit is contained in:
Andrew David Wong 2021-06-17 07:52:18 -07:00
commit 6cf3c7e9df
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
168 changed files with 245 additions and 410 deletions

View File

@ -10,7 +10,6 @@ ref: 66
title: Development Workflow
---
# Development Workflow
A workflow for developing Qubes OS+

View File

@ -10,8 +10,6 @@ ref: 65
title: Qubes Builder Details
---
[QubesBuilder](/doc/qubes-builder/) "API"
========================================
Components Makefile.builder file
--------------------------------

View File

@ -12,7 +12,6 @@ title: Qubes Builder
**Note: See [ISO building instructions](/doc/qubes-iso-building/) for a streamlined overview on how to use the build system.**
# Building Qubes from scratch
We have a fully automated build system for Qubes, that downloads, builds and
packages all the Qubes components, and finally should spit out a ready-to-use

View File

@ -12,8 +12,6 @@ ref: 63
title: Qubes ISO Building
---
Building Qubes OS ISO
=========================
Build Environment
-----------------

View File

@ -0,0 +1,7 @@
---
lang: en
layout: doc
permalink: /doc/qubes-template-configs/
redirect_to: https://github.com/QubesOS/qubes-template-configs
title: Qubes Template Configs
---

View File

@ -6,7 +6,6 @@ ref: 51
title: Code Signing
---
# Code Signing
All contributions to the Qubes OS [source code](/doc/source-code/) must be cryptographically signed by the author's PGP key.

View File

@ -11,8 +11,6 @@ ref: 53
title: Coding Style
---
Coding Guidelines for Qubes Developers
======================================
Rationale
---------

View File

@ -7,11 +7,9 @@ redirect_from:
- /doc/QubesLicensing/
- /wiki/QubesLicensing/
ref: 52
title: License
title: Software License
---
Qubes OS License
================
Qubes is a compilation of software packages, each under its own license. The compilation is made available under the GNU General Public License version 2.

View File

@ -10,8 +10,6 @@ ref: 54
title: Source Code
---
Qubes Source Code Repositories
==============================
All the Qubes code is kept in Git repositories. We have divided the project into
several components, each of which has its own separate repository, for example:

View File

@ -9,7 +9,6 @@ ref: 45
title: Automated Tests
---
# Automated Tests
## Unit and Integration Tests

View File

@ -3,10 +3,9 @@ lang: en
layout: doc
permalink: /doc/mount-lvm-image/
ref: 46
title: Mount LVM image
title: How to Mount LVM Images
---
# How to mount LVM image
You want to read your LVM image (e.g., there is a problem where you can't start any VMs except dom0).

View File

@ -7,10 +7,9 @@ redirect_from:
- /doc/Profiling/
- /wiki/Profiling/
ref: 48
title: Profiling
title: Python Profiling
---
# Profiling
This is a python profiling primer.

View File

@ -8,8 +8,6 @@ ref: 49
title: Safe Remote Dom0 Terminals
---
Safe Remote Dom0 Terminals
==========================
If you do not have working graphics in Dom0, then using a terminal can be quite annoying!
This was the case for the author while trying to debug PCI-passthrough of a machine's primary (only) GPU.

View File

@ -7,10 +7,9 @@ redirect_from:
- /doc/TestBench/
- /wiki/TestBench/
ref: 44
title: Test Bench
title: How to Set Up a Test Bench
---
# Test bench for Dom0
This guide shows how to set up simple test bench that automatically test your code you're about to push. It is written especially for `core3` branch of `core-admin.git` repo, but some ideas are universal.

View File

@ -11,7 +11,6 @@ ref: 47
title: VM Configuration Interface
---
# VM Configuration Interface
Qubes VM have some settings set by dom0 based on VM settings. There are multiple configuration channels, which includes:

View File

@ -10,7 +10,6 @@ ref: 50
title: Windows Debugging
---
# Debugging Windows HVMs
Debugging Windows code can be tricky in a virtualized environment. The guide below assumes Xen hypervisor and Windows 7 VMs.

View File

@ -10,7 +10,6 @@ ref: 30
title: Documentation Guidelines
---
# Documentation guidelines
All Qubes OS documentation pages are stored as plain text files in the dedicated [qubes-doc](https://github.com/QubesOS/qubes-doc) repository.
By cloning and regularly pulling from this repo, users can maintain their own up-to-date offline copy of all Qubes documentation rather than relying solely on the web.
@ -330,7 +329,8 @@ When making contributions, please try to observe the following style conventions
* Rationale: In the event that a user is required to read the Markdown source directly, this will make it easier to follow, e.g., numbered steps in a set of instructions.
* Use hanging indentations
where appropriate.
* Use Atx-style headings: `# h1`, `##h 2`, `### h3`, etc.
* Do not use `h1` headings (single `#` or `======` underline). These are automatically generated from the `title:` line in the YAML frontmatter.
* Use Atx-style headings: , `##h 2`, `### h3`, etc.
* When writing code blocks, use [syntax highlighting](https://github.github.com/gfm/#info-string) where [possible](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers) and use `[...]` for anything omitted.
* When providing command line examples:
* Tell the reader where to open a terminal (dom0 or a specific domU), and show the command along with its output (if any) in a code block, e.g.:

View File

@ -2,13 +2,12 @@
lang: en
layout: sidebar
permalink: /gsoc/
redirect_from: /GSoC/
redirect_from:
- /GSoC/
ref: 33
title: Google Summer of Code
---
2021 Google Summer of Code
================
## Information for Students
Thank you for your interest in participating in the [Google Summer of Code program](https://summerofcode.withgoogle.com/organizations/4675790572093440/) with the [Qubes OS team](/team/). You can read more about the Google Summer of Code program at the [official website](https://summerofcode.withgoogle.com/) and the [official FAQ](https://developers.google.com/open-source/gsoc/faq).

View File

@ -6,7 +6,6 @@ ref: 242
title: Google Season of Docs
---
# 2021 Google Season of Docs
Thank you for your interest in participating in the [2021 Google Season of Docs](https://developers.google.com/season-of-docs/) program with the [Qubes OS team](/team/). You can read more about the Google Season of Docs in the official [guides](https://developers.google.com/season-of-docs/docs/) and [FAQ](https://developers.google.com/season-of-docs/docs/faq).

View File

@ -6,8 +6,6 @@ ref: 26
title: Join
---
Joining the Qubes OS Team
=========================
The Qubes OS Project does not currently have any open positions.
This page will be updated when open positions become available.

View File

@ -6,8 +6,6 @@ ref: 29
title: Package Contributions
---
Package Contributions
=====================
_This page is for developers who wish to contribute packages.
If you want to install contributed packages, please see [installing contributed packages](/doc/installing-contributed-packages/)._

View File

@ -3,5 +3,5 @@ lang: en
layout: doc
permalink: /doc/style-guide/
ref: 27
title: Style-guide
title: Style Guide
---

View File

@ -6,7 +6,6 @@ ref: 31
title: Usability & UX
---
# Usability & UX
Software that is too complicated to use, is often unused. Because we want as many people as possible to benefit from its unique security properties, the usability and user experience of Qubes OS is an utmost priority!

View File

@ -8,7 +8,6 @@ ref: 18
title: Qubes R1.0 Release Notes
---
# Qubes R1.0 Release Notes
Detailed release notes in [this blog post](https://blog.invisiblethings.org/2012/09/03/introducing-qubes-10.html).

View File

@ -8,7 +8,6 @@ ref: 25
title: Qubes R2.0 Release Notes
---
# Qubes R2.0 Release Notes
Detailed release notes in [this blog post](https://blog.invisiblethings.org/2014/09/26/announcing-qubes-os-release-2.html)
@ -56,7 +55,7 @@ See [Installation Guide](/doc/installation-guide/).
### From Qubes R2 rc1
Upgrading from Qubes R2 rc1 should be a simple matter of installing updates for [dom0](/doc/software-update-dom0/) and [VMs](/doc/software-update-vm/).
Upgrading from Qubes R2 rc1 should be a simple matter of installing updates for [dom0](/doc/how-to-install-software-in-dom0/) and [VMs](/doc/software-update-vm/).
### From Qubes R2 beta 3 and older

View File

@ -8,8 +8,6 @@ ref: 20
title: Qubes R3.0 Release Schedule
---
Qubes R3.0 Release Schedule
===========================
| Date | Stage |
| -----------:| ------------------------------------- |

View File

@ -6,7 +6,6 @@ ref: 16
title: Qubes R3.1 release notes
---
# Qubes R3.1 release notes
## New features since 3.0
@ -16,7 +15,7 @@ title: Qubes R3.1 release notes
* LIVE edition (still alpha, not part of R3.1-rc1)
* Updated GPU drivers in dom0
* Colorful window application icons (instead of just colorful lock icon)
* PV Grub support ([documentation](/doc/managing-vm-kernel/))
* PV Grub support ([documentation](/doc/managing-vm-kernels/))
* Out of the box USB VM setup, including [handling USB mouse](https://github.com/QubesOS/qubes-app-linux-input-proxy/blob/master/README.md)
* Xen upgraded to 4.6, for better hardware support (especially Skylake platform)
* Improve updates proxy flexibility - especially repositories served over HTTPS

View File

@ -8,8 +8,6 @@ ref: 17
title: Qubes R3.1 Release Schedule
---
Qubes R3.1 Release Schedule
===========================
This schedule is based on [Version Scheme](/doc/version-scheme/#release-schedule).

View File

@ -6,7 +6,6 @@ ref: 21
title: Qubes R3.2 release notes
---
# Qubes R3.2 release notes
## New features since 3.1

View File

@ -8,8 +8,6 @@ ref: 22
title: Qubes R3.2 Release Schedule
---
Qubes R3.2 Release Schedule
===========================
This schedule is based on [Version Scheme](/doc/version-scheme/#release-schedule).

View File

@ -6,8 +6,6 @@ ref: 23
title: Qubes R4.0 release notes
---
Qubes R4.0 release notes
========================
New features since 3.2
----------------------

View File

@ -8,8 +8,6 @@ ref: 24
title: Qubes R4.0 Release Schedule
---
Qubes R4.0 Release Schedule
===========================
This schedule is based on [Version Scheme](/doc/version-scheme/#release-schedule).

View File

@ -6,8 +6,6 @@ ref: 13
title: Release Notes
---
Release Notes
=============
* [Qubes R1.0 release notes](/doc/releases/1.0/release-notes/)
* [Qubes R2.0 release notes](/doc/releases/2.0/release-notes/)

View File

@ -6,8 +6,6 @@ ref: 15
title: Release Schedules
---
Release Schedules
=================
* [Qubes R3.0 release schedule](/doc/releases/3.0/schedule/)
* [Qubes R3.1 release schedule](/doc/releases/3.1/schedule/)

View File

@ -8,8 +8,6 @@ ref: 14
title: Release Checklist
---
Release Checklist
=================
*the checklist is probably unfinished*

View File

@ -11,7 +11,6 @@ ref: 36
title: Admin API
---
# Qubes OS Admin API
## Goals

View File

@ -1,18 +1,16 @@
---
lang: en
layout: doc
permalink: /doc/dvm-impl/
permalink: /doc/disposablevm-implementation/
redirect_from:
- /doc/dvm-impl/
- /en/doc/dvm-impl/
- /doc/DVMimpl/
- /wiki/DVMimpl/
ref: 34
title: DVMimpl
title: DisposableVM Implementation
---
DisposableVM implementation in Qubes
====================================
**Note: The content below applies to Qubes R3.2.**
DisposableVM image preparation

View File

@ -10,8 +10,6 @@ ref: 43
title: Dom0 Secure Updates
---
Qubes Dom0 secure update procedure
==================================
Reasons for Dom0 updates
------------------------

View File

@ -7,12 +7,9 @@ redirect_from:
- /doc/Qfilecopy/
- /wiki/Qfilecopy/
ref: 35
title: Qfilecopy
title: Inter-VM File Copying (qfilecopy)
---
InterVM file copy design
========================
There are two cases when we need a mechanism to copy files between VMs:
- "regular" file copy - when user instructs file manager to copy a given files/directories to a different VM

View File

@ -7,16 +7,13 @@ redirect_from:
- /doc/Qfileexchgd/
- /wiki/Qfileexchgd/
ref: 40
title: Qfileexchgd
title: qfileexchgd (deprecated)
---
**This mechanism is obsolete as of Qubes Beta 1!**
==================================================
Please see this [page](/doc/qfilecopy/) instead.
qfilexchgd, the Qubes file exchange daemon
==========================================
Overview
--------

View File

@ -7,12 +7,9 @@ redirect_from:
- /doc/Qmemman/
- /wiki/Qmemman/
ref: 41
title: Qmemman
title: Qubes Memory Manager (qmemman)
---
qmemman, Qubes memory manager
=============================
Rationale
---------

View File

@ -8,10 +8,9 @@ redirect_from:
- /doc/Qrexec3Implementation/
- /wiki/Qrexec3Implementation/
ref: 39
title: 'Qrexec: Qubes RPC internals'
title: 'Qrexec: Qubes RPC Internals'
---
# Qubes RPC internals
(*This page details the current implementation of qrexec (qrexec3).
A [general introduction](/doc/qrexec/) to qrexec is also available.

View File

@ -3,10 +3,9 @@ lang: en
layout: doc
permalink: /doc/qrexec-socket-services/
ref: 42
title: 'Qrexec: Socket-based services'
title: 'Qrexec: Socket-based Services'
---
# Qrexec: Socket-based services
*This page describes how to implement and use new socket-backed services for qrexec. See [qrexec](/doc/qrexec/) for general overview of the qrexec framework.*

View File

@ -11,11 +11,9 @@ redirect_from:
- /doc/Qrexec/
- /wiki/Qrexec/
ref: 37
title: 'Qrexec: secure communication across domains'
title: 'Qrexec: Secure Communication Across Domains'
---
# Qrexec: secure communication across domains
(*This page is about qrexec v3. For qrexec v2, see [here](/doc/qrexec2/).*)
The **qrexec framework** is used by core Qubes components to implement communication between domains.
@ -203,7 +201,7 @@ This is why `qubes.StartApp` uses our standard `qrexec` argument grammar to stri
### Service policies with arguments
Sometimes a service name alone isn't enough to make reasonable qrexec policy.
One example of such a situation is [qrexec-based USB passthrough](/doc/usb-devices/).
One example of such a situation is [qrexec-based USB passthrough](/doc/how-to-use-usb-devices/).
Using just a service name would make it difficult to express the policy "allow access to devices X and Y, but deny to all others."
It isn't feasible to create a separate service for every device: we would need to change the code in multiple files any time we wanted to update the service.

View File

@ -8,12 +8,10 @@ redirect_from:
- /doc/Qrexec2Implementation/
- /wiki/Qrexec2Implementation/
ref: 38
title: Qrexec2
title: qrexec v2 (deprecated)
---
# Command execution in VMs #
(*This page is about qrexec v2. For qrexec v3, see [here](/doc/qrexec3/).*)
(*This page is about qrexec v2. For qrexec v3, see [here](/doc/qrexec/).*)
Qubes **qrexec** is a framework for implementing inter-VM (incl. Dom0-VM)
services. It offers a mechanism to start programs in VMs, redirect their

View File

@ -11,8 +11,6 @@ ref: 56
title: Architecture
---
Qubes Architecture Overview
===========================
Qubes implements a Security by Isolation approach. To do this, Qubes utilizes virtualization technology in order to isolate various programs from each other and even to sandbox many system-level components, such as networking and storage subsystems, so that the compromise of any of these programs or components does not affect the integrity of the rest of the system.

View File

@ -6,8 +6,6 @@ ref: 60
title: Audio Virtualization
---
Audio Virtualization
====================
VMs on Qubes OS have access to virtualized audio through the PulseAudio module.
It consists of two parts:

View File

@ -8,12 +8,9 @@ redirect_from:
- /doc/GUIdocs/
- /wiki/GUIdocs/
ref: 61
title: GUI
title: GUI Virtualization
---
Qubes GUI protocol
==================
qubes_gui and qubes_guid processes
------------------------------------

View File

@ -11,7 +11,6 @@ ref: 59
title: Networking
---
# VM network in Qubes
## Overall description

View File

@ -0,0 +1,7 @@
---
lang: en
layout: doc
permalink: /doc/qubes-admin-api/
redirect_to: /news/2017/06/27/qubes-admin-api/
title: Qubes Admin API
---

View File

@ -0,0 +1,7 @@
---
lang: en
layout: doc
permalink: /doc/qubes-core-admin-client/
redirect_to: https://dev.qubes-os.org/projects/core-admin-client/en/latest/
title: Qubes Core Admin Client
---

View File

@ -0,0 +1,7 @@
---
lang: en
layout: doc
permalink: /doc/qubes-core-admin/
redirect_to: https://dev.qubes-os.org/projects/core-admin/en/latest/
title: Qubes Core Admin
---

View File

@ -0,0 +1,7 @@
---
lang: en
layout: doc
permalink: /doc/qubes-core-stack/
redirect_to: /news/2017/10/03/core3/
title: Qubes Core Stack
---

View File

@ -11,8 +11,6 @@ ref: 55
title: Security-critical Code
---
Security-critical Code in Qubes OS
==================================
Below is a list of security-critical (i.e., trusted) code components in Qubes OS.
A successful attack against any of these components could compromise the system's security.

View File

@ -9,10 +9,9 @@ redirect_from:
- /doc/SecurityGoals/
- /wiki/SecurityGoals/
ref: 210
title: Security Goals
title: Security Design Goals
---
# Security design goals
Qubes OS implements a security-by-isolation (or security-by-compartmentalization) approach by providing the ability to easily create many security domains. These domains are implemented as lightweight Virtual Machines (VMs) running under the Xen hypervisor. Qubes' main objective is to provide strong isolation between these domains, so that even if an attacker compromises one of the domains, the others are still safe. Qubes, however, does not attempt to provide any security isolation for applications running within the same domain. For example, a buggy web browser running in a Qubes domain could still be compromised just as easily as on a regular Linux distribution. The difference that Qubes makes is that now the attacker doesn't have access to all the software running in the other domains.

View File

@ -6,8 +6,6 @@ ref: 57
title: Storage Pools
---
Storage Pools in Qubes
======================
Qubes OS R3.2 introduced the concept of storage drivers and pools. This feature
was a first step towards a saner storage API, which is heavily rewritten in R4.

View File

@ -10,7 +10,6 @@ ref: 58
title: Template Implementation
---
# Overview of VM block devices
Every VM has 4 block devices connected:

View File

@ -1,7 +1,8 @@
---
lang: en
layout: doc
redirect_from: /en/doc/fedora-minimal-template-customization/
redirect_from:
- /en/doc/fedora-minimal-template-customization/
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/customization/fedora-minimal-template-customization.md
ref: 76
title: Fedora Minimal Template Customization

View File

@ -7,12 +7,9 @@ redirect_from:
- /doc/ContributingHowto/
- /wiki/ContributingHowto/
ref: 125
title: Contributing to the Qubes OS Project
title: How to Contribute
---
How to Contribute to the Qubes OS Project
=========================================
Thank you for your interest in contributing to Qubes! Here are some of the many
ways in which you can help:

View File

@ -15,8 +15,6 @@ ref: 124
title: Frequently Asked Questions
---
# Frequently Asked Questions
## General & Security
### What is Qubes OS?
@ -253,7 +251,7 @@ Please refer to [this page](/doc/vm-sudo/).
Please see:
- [Installing and updating software in dom0](/doc/software-update-dom0/)
- [Installing and updating software in dom0](/doc/how-to-install-software-in-dom0/)
- [Note on dom0 and EOL](/doc/supported-versions/#note-on-dom0-and-eol)
### Do you recommend coreboot as an alternative to vendor BIOS?
@ -505,7 +503,7 @@ For Debian:
For Fedora:
1. (Recommended) Clone an existing Fedora TemplateVM
2. [Enable the appropriate RPMFusion repos in the desired Fedora TemplateVM](/doc/software-update-domu/#rpmfusion-for-fedora-templatevms).
2. [Enable the appropriate RPMFusion repos in the desired Fedora TemplateVM](/doc/how-to-install-software/#rpmfusion-for-fedora-templatevms).
3. Install VLC in that TemplateVM:
```bash_session
@ -527,7 +525,7 @@ From the top part of the list, click on the drive you want to attach, then selec
Although you can also attach the entire USB device to a qube by selecting it from the bottom part of the list, in general this approach should not be used because you are exposing the target qube to unnecessary additional attack surface.
Although external media such as external hard drives or flash drives plugged in via USB are available in the USB qube, it is not recommended to access them directly from inside the USB qube.
See [Block (Storage) Devices](/doc/block-devices/) for more information.
See [Block (Storage) Devices](/doc/how-to-use-block-storage-devices/) for more information.
### My encrypted drive doesn't appear in Debian qube.

View File

@ -12,11 +12,9 @@ redirect_from:
- /bug-report/
- /bug-reports/
ref: 121
title: Reporting bugs and other issues
title: Reporting Bugs and Other Issues
---
# Reporting bugs and other issues #
All issues pertaining to the Qubes OS Project (including auxiliary infrastructure such as the [website](/)) are tracked in [qubes-issues](https://github.com/QubesOS/qubes-issues/issues), our GitHub issue tracker.
If you're looking for help, please see [Help, Support, Mailing Lists, and Forum](/support/).
@ -106,7 +104,7 @@ The Qubes team will classify your issue according to its type.
### New issues should include all relevant information ###
When you file a new issue, you should be sure to include the version of Qubes you're using, as well as versions of related software packages ([how to copy information out of dom0](/doc/copy-from-dom0/)).
When you file a new issue, you should be sure to include the version of Qubes you're using, as well as versions of related software packages ([how to copy information out of dom0](/doc/how-to-copy-from-dom0/)).
If your issue is related to hardware, provide as many details as possible about the hardware.
A great way to do this is by [generating and submitting a Hardware Compatibility List (HCL) report](/doc/hcl/#generating-and-submitting-new-reports), then linking to it in your issue.
You may also need to use command-line tools such as `lspci`.

View File

@ -10,8 +10,6 @@ ref: 123
title: Screenshots
---
Select Qubes OS Screenshots
===========================
[![r4.0-xfce-desktop.png](/attachment/wiki/QubesScreenshots/r4.0-xfce-desktop.png)](/attachment/wiki/QubesScreenshots/r4.0-xfce-desktop.png)

View File

@ -15,8 +15,6 @@ ref: 122
title: Help, Support, Mailing Lists, and Forum
---
# Help, Support, Mailing Lists, and Forum
Help and support for Qubes OS is available from the [documentation](/doc/), the
[mailing lists](#mailing-lists), and our [forum](#forum) which are explained below. The Qubes OS
Project does not offer paid support services.

View File

@ -3,7 +3,7 @@ lang: en
layout: default
permalink: /video-tours/
ref: 226
title: Video Tours of Qubes OS
title: Video Tours
---
<div id="tour">

View File

@ -2,12 +2,12 @@
lang: en
layout: doc
permalink: /security/bulletins/checklist/
redirect_from: /doc/security-bulletins/checklist/
redirect_from:
- /doc/security-bulletins/checklist/
ref: 215
title: Security Bulletin Checklist
---
# Security Bulletin Checklist
## Preparation

View File

@ -2,14 +2,12 @@
lang: en
layout: doc
permalink: /security/bulletins/template/
redirect_from: /doc/security-bulletins/template/
redirect_from:
- /doc/security-bulletins/template/
ref: 209
title: Security Bulletin Template
---
Security Bulletin Template
==========================
~~~
Dear Qubes Community,

View File

@ -12,7 +12,6 @@ ref: 218
title: Qubes Security Bulletins (QSBs)
---
# Qubes Security Bulletins (QSBs)
A **Qubes Security Bulletin (QSB)** is a security announcement issued by the [Qubes Security Team](/security/#the-qubes-security-team) through the [Qubes Security Pack](/security/pack/).
A QSB typically provides a summary and impact analysis of one or more recently-discovered software vulnerabilities, including details about patching to address them.

View File

@ -2,12 +2,12 @@
lang: en
layout: doc
permalink: /security/canaries/
redirect_from: /doc/canaries/
redirect_from:
- /doc/canaries/
ref: 208
title: Canaries
title: Qubes Canaries
---
# Qubes Canaries
A **Qubes Canary** is a security announcement periodically issued by the [Qubes Security Team](/security/#the-qubes-security-team) through the [Qubes Security Pack](/security/pack/) consisting of several statements to the effect that the signers of the canary have not been compromised.
The idea is that, as long as signed canaries including such statements continue to be published, all is well.

View File

@ -6,7 +6,6 @@ ref: 216
title: Canary Checklist
---
# Canary Checklist
## Preparation

View File

@ -2,13 +2,12 @@
lang: en
layout: doc
permalink: /security/canaries/template/
redirect_from: /doc/canaries/template/
redirect_from:
- /doc/canaries/template/
ref: 212
title: Canary Template
---
Canary Template
===============
~~~
Dear Qubes community,

View File

@ -0,0 +1,7 @@
---
lang: en
layout: doc
permalink: /security/pgp-keys/
redirect_to: https://keys.qubes-os.org/keys/
title: PGP keys
---

View File

@ -15,11 +15,9 @@ redirect_from:
- /doc/sec-pack/
- /doc/secpack/
ref: 213
title: Security Pack
title: Qubes Security Pack (qubes-secpack)
---
Qubes Security Pack
===================
The **Qubes Security Pack** (`qubes-secpack`) is a Git repository that contains:

View File

@ -13,11 +13,9 @@ redirect_from:
- /wiki/SecurityPage/
- /trac/wiki/SecurityPage/
ref: 217
title: Security
title: Qubes OS Project Security Center
---
# Qubes OS Project Security Center
This page provides a central hub for topics pertaining to the security of the Qubes OS Project.
For topics pertaining to software security *within* Qubes OS, see [Security in Qubes](/doc/#security-in-qubes).
The following is a list of important project security pages:

View File

@ -11,7 +11,6 @@ ref: 211
title: Verifying Signatures
---
# On Digital Signatures and Key Verification
## What Digital Signatures Can and Cannot Prove
@ -216,7 +215,7 @@ The filename of the Release Signing Key for your version is usually `qubes-relea
There are several ways to get the Release Signing Key for your Qubes release.
- If you have access to an existing Qubes installation, the release keys are available in dom0 in `/etc/pki/rpm-gpg/RPM-GPG-KEY-qubes-*`.
These can be [copied](/doc/copy-from-dom0/#copying-from-dom0) into other VMs for further use.
These can be [copied](/doc/how-to-copy-from-dom0/#copying-from-dom0) into other VMs for further use.
In addition, every other VM contains the release key corresponding to that installation's release in `/etc/pki/rpm-gpg/RPM-GPG-KEY-qubes-*`.
If you wish to use one of these keys, make sure to import it into your keyring, e.g.:

View File

@ -6,8 +6,6 @@ ref: 214
title: Xen Security Advisory (XSA) Tracker
---
Xen Security Advisory (XSA) Tracker
===================================
This tracker shows whether Qubes OS is affected by any given [Xen Security Advisory (XSA)](https://xenbits.xen.org/xsa/).
Shortly after a new XSA is published, we will add a new row to this tracker.

View File

@ -5,10 +5,9 @@ permalink: /doc/awesome/
redirect_from:
- /en/doc/awesome/
ref: 179
title: awesome
title: awesome (window manager)
---
# Using awesome in dom0
## Qubes-specific features

View File

@ -5,10 +5,9 @@ permalink: /doc/bind-dirs/
redirect_from:
- /en/doc/bind-dirs/
ref: 186
title: How to make any file in a TemplateBasedVM persistent using bind-dirs
title: How to Make Any File Persistent (bind-dirs)
---
# How to make any file in a TemplateBasedVM persistent using bind-dirs #
## What are bind-dirs? ##

View File

@ -11,8 +11,6 @@ ref: 180
title: Config Files
---
Configuration Files
===================
Qubes-specific VM config files
------------------------------

View File

@ -12,7 +12,6 @@ ref: 174
title: DisposableVM Customization
---
# DisposableVM Customization
## Introduction
@ -103,8 +102,8 @@ For example, with `qvm-prefs work netvm sys-firewall2`.
To create one with a PCI device attached such as for `sys-net` or `sys-usb`, use the additional commands as follows.
**Note** You can use `qvm-pci` to [determine](/doc/pci-devices/#qvm-pci-usage) the `<BDF>`.
Also, you will often need to include the `-o no-strict-reset=True` [option](/doc/pci-devices/#no-strict-reset) with USB controllers.
**Note** You can use `qvm-pci` to [determine](/doc/how-to-use-pci-devices/#qvm-pci-usage) the `<BDF>`.
Also, you will often need to include the `-o no-strict-reset=True` [option](/doc/how-to-use-pci-devices/#no-strict-reset) with USB controllers.
~~~
qvm-create -C DispVM -l red <sys-VMName>
@ -210,7 +209,7 @@ Using DisposableVMs in this manner is ideal for untrusted qubes which require pe
[user@dom0 ~]$ qvm-pci
```
6. Attach the network PCI device(s) to `disp-sys-net` (finding and assigning PCI devices can be found [here](/doc/pci-devices/):
6. Attach the network PCI device(s) to `disp-sys-net` (finding and assigning PCI devices can be found [here](/doc/how-to-use-pci-devices/):
```shell_session
[user@dom0 ~]$ qvm-pci attach --persistent disp-sys-net <backend>:<bdf>
@ -307,7 +306,7 @@ Using DisposableVMs in this manner is ideal for untrusted qubes which require pe
```
5. Attach the USB controller to the `disp-sys-usb`:
>_**Note:**_ Most of the commonly used USB controllers (all Intel integrated controllers) require the `-o no-strict-reset=True` option to be set. Instructions detailing how this option is set can be found [here](/doc/pci-devices/#no-strict-reset).
>_**Note:**_ Most of the commonly used USB controllers (all Intel integrated controllers) require the `-o no-strict-reset=True` option to be set. Instructions detailing how this option is set can be found [here](/doc/how-to-use-pci-devices/#no-strict-reset).
```shell_session
[user@dom0 ~]$ qvm-pci attach --persistent disp-sys-usb <backined>:<bdf>

View File

@ -2,12 +2,10 @@
lang: en
layout: doc
permalink: /doc/gui-configuration/
redirect_from: []
ref: 184
title: GUI Configuration
---
# GUI Configuration
## Video RAM adjustment for high-resolution displays

View File

@ -1,21 +1,20 @@
---
lang: en
layout: doc
permalink: /doc/software-update-dom0/
permalink: /doc/how-to-install-software-in-dom0/
redirect_from:
- /doc/software-update-dom0/
- /en/doc/software-update-dom0/
- /doc/SoftwareUpdateDom0/
- /wiki/SoftwareUpdateDom0/
ref: 194
title: Installing and updating software in dom0
title: How to Install Software in Dom0
---
# Installing and updating software in dom0
Updating [dom0](/doc/glossary/#dom0) is one of the main steps in [Updating Qubes OS](/doc/updating-qubes-os/).
It is very important to keep dom0 up-to-date with the latest [security](/security/) updates.
We also publish dom0 updates for various non-security bug fixes and enhancements to Qubes components.
In addition, you may wish to update the kernel, drivers, or libraries in dom0 when [troubleshooting newer hardware](/doc/newer-hardware-troubleshooting/).
<div class="alert alert-danger" role="alert">
<i class="fa fa-exclamation-triangle"></i>
<b>Warning:</b> Installing software in dom0 is for advanced users only. Doing so has the potential to compromise your entire Qubes OS installation. Exercise extreme caution.
</div>
## Security
@ -145,7 +144,7 @@ In the `current-testing` repository:
### domU
The packages `kernel-qubes-vm` and `kernel-latest-qubes-vm` are for domUs.
See [Managing VM kernel](/doc/managing-vm-kernel/) for more information.
See [Managing VM kernel](/doc/managing-vm-kernels/) for more information.
### Example

View File

@ -7,13 +7,12 @@ redirect_from:
- /doc/UserDoc/i3/
- /wiki/UserDoc/i3/
ref: 183
title: i3
title: i3 (window manager)
---
# i3 installation in dom0
i3 is part of the stable repository (as of Qubes R3.1) and can be installed by
using the [dom0 update mechanism](/doc/software-update-dom0/). To install the i3
using the [dom0 update mechanism](/doc/how-to-install-software-in-dom0/). To install the i3
window manager and the its Qubes specific configuration:
```shell_session

View File

@ -3,10 +3,9 @@ lang: en
layout: doc
permalink: /doc/installing-contributed-packages/
ref: 225
title: Installing contributed packages
title: Installing Contributed Packages
---
# Installing contributed packages
_This page is for users who wish to install contributed packages.
If you want to contribute a package, please see [package contributions](/doc/package-contributions/)._

View File

@ -2,13 +2,12 @@
lang: en
layout: doc
permalink: /doc/kde/
redirect_from: /en/doc/kde/
redirect_from:
- /en/doc/kde/
ref: 176
title: KDE
title: KDE (desktop environment)
---
Using KDE in dom0
=================
Installation
------------

View File

@ -1,17 +1,17 @@
---
lang: en
layout: doc
permalink: /doc/managing-vm-kernel/
permalink: /doc/managing-vm-kernels/
redirect_from:
- /doc/managing-vm-kernel/
- /en/doc/managing-vm-kernel/
ref: 173
title: Managing VM kernel
title: Managing VM Kernels
---
# VM kernel managed by dom0
By default, VMs kernels are provided by dom0.
(See [here](/doc/software-update-dom0/#kernel-upgrade) for information about upgrading kernels in dom0.)
(See [here](/doc/how-to-install-software-in-dom0/#kernel-upgrade) for information about upgrading kernels in dom0.)
This means that:
1. You can select the kernel version (using GUI VM Settings tool or `qvm-prefs` commandline tool);

View File

@ -7,11 +7,9 @@ redirect_from:
- /doc/MountFromOtherOs/
- /wiki/MountFromOtherOs/
ref: 175
title: Mounting and Decrypting Qubes Partitions from Outside Qubes
title: How to Mount a Qubes Partition from Another OS
---
Mount and Decrypt Qubes Partition from Outside Qubes
====================================================
When a Qubes OS install is unbootable or booting it is otherwise undesirable, this process allows for the recovery of files stored within the system.

View File

@ -6,8 +6,6 @@ ref: 178
title: RPC Policies
---
RPC Policies
============
This document explains the basics of RPC policies in Qubes.
For more information, see [Qrexec: command execution in VMs](/doc/qrexec3/).

View File

@ -3,10 +3,9 @@ lang: en
layout: doc
permalink: /doc/salt/
ref: 185
title: Management stack
title: Salt (management stack)
---
# Management Infrastructure
Since the Qubes R3.1 release we have included the Salt (also called SaltStack)
management engine in dom0 as default (with some states already configured).

View File

@ -10,7 +10,6 @@ ref: 187
title: Secondary Storage
---
# Storing AppVMs on Secondary Drives
Suppose you have a fast but small primary SSD and a large but slow secondary HDD.
You want to store a subset of your AppVMs on the HDD.

View File

@ -12,7 +12,6 @@ ref: 130
title: StandaloneVMs and HVMs
---
# StandaloneVMs and HVMs
A [StandaloneVM](/doc/glossary/#standalonevm) is a type of VM in Qubes that is created by cloning a [TemplateVM](/doc/templates/).
Unlike TemplateVMs, however, StandaloneVMs do not supply their root filesystems to other VMs.

View File

@ -12,7 +12,6 @@ ref: 181
title: USB Qubes
---
# USB Qubes #
If during installation you enabled the creation of a USB-qube, your system should be setup already and none of the mentioned steps here should be necessary. (Unless you want to [remove your USB-qube](#removing-a-usb-qube).) If for any reason no USB-qube was created during installation, this guide will show you how to do so.
@ -26,8 +25,8 @@ If you find yourself in this situation, see this [issue](https://github.com/Qube
A USB qube acts as a secure handler for potentially malicious USB devices, preventing them from coming into contact with dom0 (which could otherwise be fatal to the security of the whole system). It thereby mitigates some of the [security implications](/doc/device-handling-security/#usb-security) of using USB devices.
With a USB qube, every time you connect an untrusted USB drive to a USB port managed by that USB controller, you will have to attach it to the qube in which you wish to use it (if different from the USB qube itself), either by using Qubes VM Manager or the command line (see instructions above).
The USB controller may be assigned on the **Devices** tab of a qube's settings page in Qubes VM Manager or by using the [qvm-pci](/doc/pci-devices/) command.
For guidance on finding the correct USB controller, see the [according passage on PCI-devices](/doc/usb-devices/#finding-the-right-usb-controller).
The USB controller may be assigned on the **Devices** tab of a qube's settings page in Qubes VM Manager or by using the [qvm-pci](/doc/how-to-use-pci-devices/) command.
For guidance on finding the correct USB controller, see the [according passage on PCI-devices](/doc/how-to-use-usb-devices/#finding-the-right-usb-controller).
You can create a USB qube using the management stack by performing the following steps as root in dom0:
```
@ -36,7 +35,7 @@ sudo qubesctl state.sls qvm.sys-usb
Alternatively, you can create a USB qube manually as follows:
1. Read the [PCI Devices](/doc/pci-devices/) page to learn how to list and identify your USB controllers.
1. Read the [PCI Devices](/doc/how-to-use-pci-devices/) page to learn how to list and identify your USB controllers.
Carefully check whether you have a USB controller that would be appropriate to assign to a USB qube.
Note that it should be free of input devices, programmable devices, and any other devices that must be directly available to dom0.
If you find a free controller, note its name and proceed to step 2.
@ -66,7 +65,7 @@ Those steps are not performed by default, because of risk explained in [Security
### Automatic setup ###
To allow USB keyboard usage (including early boot for LUKS passphrase), make sure you have the latest `qubes-mgmt-salt-dom0-virtual-machines` package (simply [install dom0 updates](/doc/software-update-dom0/#how-to-update-dom0)) and execute in dom0:
To allow USB keyboard usage (including early boot for LUKS passphrase), make sure you have the latest `qubes-mgmt-salt-dom0-virtual-machines` package (simply [install dom0 updates](/doc/how-to-install-software-in-dom0/#how-to-update-dom0)) and execute in dom0:
```
sudo qubesctl state.sls qvm.usb-keyboard

View File

@ -10,8 +10,6 @@ ref: 206
title: Volume Backup and Revert
---
Qubes Volume Backup and Revert
==============================
With Qubes, it is possible to revert one of a VM's storage volumes to a previous
state using the automatic snapshot that is normally saved every time a VM is

View File

@ -6,8 +6,6 @@ ref: 129
title: Windows VMs
---
Windows VMs in Qubes OS
=======================
Like any other unmodified OSes, Windows can be installed in Qubes as an [HVM](/doc/standalone-and-hvm/) domain.

View File

@ -8,7 +8,6 @@ ref: 152
title: Custom Installation
---
# Custom Installation
In the present context, "custom installation" refers to things like manual partitioning, setting up LVM and RAID, and manual LUKS encryption configuration.

View File

@ -6,8 +6,6 @@ ref: 148
title: Download Mirrors
---
Qubes Download Mirrors
======================
List of Download Mirrors
------------------------

View File

@ -0,0 +1,7 @@
---
lang: en
layout: doc
permalink: /doc/downloads/
redirect_to: /downloads/
title: Downloads
---

View File

@ -10,7 +10,6 @@ ref: 149
title: Installation security
---
# Installation security
There are several security matters to consider before and during the Qubes installation process.

Some files were not shown because too many files have changed in this diff Show More