mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2025-12-10 13:40:14 -05:00
Remove extra newlines at the beginning/end of files
Those are redundant, and yaml parser strips them in fact. By removing them, loading and saving yaml file without any change indeed produce the same output. This is useful for prepare_for_translation.py script (which adds lang and ref tags) - to produce only change that indeed was made.
This commit is contained in:
parent
4851518719
commit
3806ecf338
130 changed files with 0 additions and 168 deletions
|
|
@ -10,7 +10,6 @@ ref: 66
|
|||
title: Development Workflow
|
||||
---
|
||||
|
||||
|
||||
A workflow for developing Qubes OS+
|
||||
|
||||
First things first, setup [QubesBuilder](/doc/qubes-builder/). This guide
|
||||
|
|
@ -537,4 +536,3 @@ Usage: add this line to `/etc/apt/sources.list` on test machine (adjust host and
|
|||
~~~
|
||||
deb http://local-test.lan/linux-deb/r3.1 jessie-unstable main
|
||||
~~~
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ ref: 65
|
|||
title: Qubes Builder Details
|
||||
---
|
||||
|
||||
|
||||
Components Makefile.builder file
|
||||
--------------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,6 @@ ref: 63
|
|||
title: Qubes ISO Building
|
||||
---
|
||||
|
||||
|
||||
Build Environment
|
||||
-----------------
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 51
|
|||
title: Code Signing
|
||||
---
|
||||
|
||||
|
||||
All contributions to the Qubes OS [source code](/doc/source-code/) must be cryptographically signed by the author's PGP key.
|
||||
|
||||
## Generating a Key
|
||||
|
|
@ -202,4 +201,3 @@ Please upload it.
|
|||
If you're submitting a patch by emailing the [developer mailing list](/support/#qubes-devel), simply sign your email with your PGP key.
|
||||
One good way to do this is with a program like [Enigmail](https://www.enigmail.net/).
|
||||
Enigmail is a security addon for the Mozilla Thunderbird email client that allows you to easily digitally encrypt and sign your emails.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ ref: 53
|
|||
title: Coding Style
|
||||
---
|
||||
|
||||
|
||||
Rationale
|
||||
---------
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ ref: 52
|
|||
title: Software 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.
|
||||
|
||||
The full text of the GPL v2 license can be found [here](https://www.gnu.org/licenses/gpl-2.0.html).
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ ref: 54
|
|||
title: Source Code
|
||||
---
|
||||
|
||||
|
||||
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:
|
||||
|
||||
|
|
@ -81,4 +80,3 @@ method you choose, you must [sign your code](/doc/code-signing/) before it can b
|
|||
name and email, so that *your* name will be used as a commit's author.
|
||||
5. Send your patch to `qubes-devel`. Start the message subject with
|
||||
`[PATCH]`.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,6 @@ ref: 45
|
|||
title: Automated Tests
|
||||
---
|
||||
|
||||
|
||||
## Unit and Integration Tests
|
||||
|
||||
Starting with Qubes R3 we use [python unittest](https://docs.python.org/3/library/unittest.html) to perform automatic tests of Qubes OS.
|
||||
|
|
@ -260,4 +259,3 @@ In practice, however, either Xen or QEMU crashes when this is attempted.
|
|||
Nonetheless, PV works well, which is sufficient for automated installation testing.
|
||||
|
||||
Thanks to an anonymous donor, our openQA system is hosted in a datacenter on hardware that meets these requirements.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 46
|
|||
title: How to Mount LVM Images
|
||||
---
|
||||
|
||||
|
||||
You want to read your LVM image (e.g., there is a problem where you can't start any VMs except dom0).
|
||||
|
||||
1: make the image available for qubesdb.
|
||||
|
|
@ -53,4 +52,3 @@ From the GUI, or from the command line:
|
|||
# References
|
||||
|
||||
Please consult this issue's [comment](https://github.com/QubesOS/qubes-issues/issues/4687#issuecomment-451626625).
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ ref: 48
|
|||
title: Python Profiling
|
||||
---
|
||||
|
||||
|
||||
This is a python profiling primer.
|
||||
|
||||
For the purpose of this document, `qubes-dev` is name of the domain used for postprocessing profiling stats.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ ref: 49
|
|||
title: 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.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ ref: 44
|
|||
title: How to Set Up a Test Bench
|
||||
---
|
||||
|
||||
|
||||
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.
|
||||
|
||||
We will set up a spare machine (bare metal, not a virtual) that will be hosting our experimental Dom0. We will communicate with it via Ethernet and SSH. This tutorial assumes you are familiar with [QubesBuilder](/doc/qubes-builder/) and you have it set up and running flawlessly.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ ref: 47
|
|||
title: VM Configuration Interface
|
||||
---
|
||||
|
||||
|
||||
Qubes VM have some settings set by dom0 based on VM settings. There are multiple configuration channels, which includes:
|
||||
|
||||
- QubesDB
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ ref: 50
|
|||
title: Windows Debugging
|
||||
---
|
||||
|
||||
|
||||
Debugging Windows code can be tricky in a virtualized environment. The guide below assumes Xen hypervisor and Windows 7 VMs.
|
||||
|
||||
User-mode debugging is usually straightforward if it can be done on one machine. Just duplicate your normal debugging environment in the VM.
|
||||
|
|
|
|||
|
|
@ -561,4 +561,3 @@ Here's an example that follows the indentation rules:
|
|||
|
||||
Please try to write good commit messages, according to the [instructions in our
|
||||
coding style guidelines](/doc/coding-style/#commit-message-guidelines).
|
||||
|
||||
|
|
|
|||
|
|
@ -586,4 +586,3 @@ would override all the user changes there). More details:
|
|||
----
|
||||
|
||||
We adapted some of the language here about GSoC from the [KDE GSoC page](https://community.kde.org/GSoC).
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 242
|
|||
title: 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).
|
||||
|
||||
## 2021 Project Idea
|
||||
|
|
@ -145,4 +144,3 @@ Fixing this last point may require very close cooperation with developers, as th
|
|||
- [Markdown](https://daringfireball.net/projects/markdown/)
|
||||
|
||||
**Mentor**: [Marek Marczykowski-Górecki](/team/)
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 29
|
|||
title: 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/)._
|
||||
|
||||
|
|
@ -101,4 +100,3 @@ As the maintainer of the package, it is your privilege and responsibility to:
|
|||
|
||||
If you do not wish to be the maintainer of your package, please let us know.
|
||||
If you do not act on your maintainer duties for a given package for an extended period of time and after at least one reminder, we will assume that you no longer wish to be the maintainer for that package.
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 31
|
|||
title: 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!
|
||||
|
||||
We ask anyone developing for Qubes OS to please read through this guide to better understand the user experience we strive to achieve. We also ask them to review [our style guide](/doc/style-guide/) for other design related information.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ ref: 18
|
|||
title: Qubes R1.0 Release Notes
|
||||
---
|
||||
|
||||
|
||||
Detailed release notes in [this blog post](https://blog.invisiblethings.org/2012/09/03/introducing-qubes-10.html).
|
||||
|
||||
## Known issues
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ ref: 25
|
|||
title: 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)
|
||||
|
||||
## New features since 1.0
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ ref: 20
|
|||
title: Qubes R3.0 Release Schedule
|
||||
---
|
||||
|
||||
|
||||
| Date | Stage |
|
||||
| -----------:| ------------------------------------- |
|
||||
| 5 Sep 2015 | current-testing freeze before 3.0-rc3 |
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 16
|
|||
title: Qubes R3.1 release notes
|
||||
---
|
||||
|
||||
|
||||
## New features since 3.0
|
||||
|
||||
* Management Stack based of Salt Stack in dom0 - [documentation](/doc/salt/)
|
||||
|
|
@ -64,4 +63,3 @@ for migrating of all of the user VMs.
|
|||
Alternatively you can [upgrade to R3.0
|
||||
using](/doc/releases/3.0/release-notes/#upgrading) first, then follow the
|
||||
instructions above. This will be time consuming process.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ ref: 17
|
|||
title: Qubes R3.1 Release Schedule
|
||||
---
|
||||
|
||||
|
||||
This schedule is based on [Version Scheme](/doc/version-scheme/#release-schedule).
|
||||
|
||||
| Date | Stage |
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 21
|
|||
title: Qubes R3.2 release notes
|
||||
---
|
||||
|
||||
|
||||
## New features since 3.1
|
||||
|
||||
* Management Stack extended to support in-VM configuration - [documentation](/doc/salt/)
|
||||
|
|
@ -60,4 +59,3 @@ for migrating of all of the user VMs.
|
|||
|
||||
Alternatively you can [upgrade to R3.1 using](/doc/releases/3.1/release-notes/#upgrading) first, then follow
|
||||
the instructions above. This will be time consuming process.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ ref: 22
|
|||
title: Qubes R3.2 Release Schedule
|
||||
---
|
||||
|
||||
|
||||
This schedule is based on [Version Scheme](/doc/version-scheme/#release-schedule).
|
||||
|
||||
| Date | Stage |
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 23
|
|||
title: Qubes R4.0 release notes
|
||||
---
|
||||
|
||||
|
||||
New features since 3.2
|
||||
----------------------
|
||||
|
||||
|
|
@ -106,4 +105,3 @@ There is no in-place upgrade path from earlier Qubes versions. The only
|
|||
supported option to upgrade to Qubes R4.0 is to install it from scratch and use
|
||||
[qubes backup and restore tools](/doc/backup-restore/) for migrating of all of the user VMs.
|
||||
We also provide [detailed instruction](/doc/upgrade-to-r4.0/) for this procedure.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ ref: 24
|
|||
title: Qubes R4.0 Release Schedule
|
||||
---
|
||||
|
||||
|
||||
This schedule is based on [Version Scheme](/doc/version-scheme/#release-schedule).
|
||||
|
||||
| Date | Stage |
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 13
|
|||
title: Release Notes
|
||||
---
|
||||
|
||||
|
||||
* [Qubes R1.0 release notes](/doc/releases/1.0/release-notes/)
|
||||
* [Qubes R2.0 release notes](/doc/releases/2.0/release-notes/)
|
||||
* [Qubes R3.0 release notes](/doc/releases/3.0/release-notes/)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 15
|
|||
title: Release Schedules
|
||||
---
|
||||
|
||||
|
||||
* [Qubes R3.0 release schedule](/doc/releases/3.0/schedule/)
|
||||
* [Qubes R3.1 release schedule](/doc/releases/3.1/schedule/)
|
||||
* [Qubes R3.2 release schedule](/doc/releases/3.2/schedule/)
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ ref: 14
|
|||
title: Release Checklist
|
||||
---
|
||||
|
||||
|
||||
*the checklist is probably unfinished*
|
||||
|
||||
On -rc1
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ ref: 151
|
|||
title: Version Scheme
|
||||
---
|
||||
|
||||
|
||||
Beginning with R3 release, we change (and formalise) the versioning scheme.
|
||||
From now on, it will be as follows.
|
||||
|
||||
|
|
@ -155,4 +154,3 @@ Check installed version
|
|||
|
||||
If you want to know which version you are running, for example to report
|
||||
an issue, you can either check in the Qubes Manager menu under About / Qubes OS or in the file /etc/qubes-release in dom0. For the latter you can use a command like `cat /etc/qubes-release` in a dom0 terminal.
|
||||
|
||||
|
|
|
|||
|
|
@ -274,4 +274,3 @@ In addition, there is a mechanism to prevent concurrent modifications of the pol
|
|||
`qrexec-client-vm`
|
||||
|
||||
<!-- vim: set ts=4 sts=4 sw=4 et : -->
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ ref: 43
|
|||
title: Dom0 Secure Updates
|
||||
---
|
||||
|
||||
|
||||
Reasons for Dom0 updates
|
||||
------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ ref: 39
|
|||
title: 'Qrexec: Qubes RPC Internals'
|
||||
---
|
||||
|
||||
|
||||
(*This page details the current implementation of qrexec (qrexec3).
|
||||
A [general introduction](/doc/qrexec/) to qrexec is also available.
|
||||
For the implementation of qrexec2, see [here](/doc/qrexec2/#qubes-rpc-internals).*)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 42
|
|||
title: '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.*
|
||||
|
||||
As of Qubes 4.1, qrexec allows implementing services not only as executable files, but also as Unix sockets.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 60
|
|||
title: Audio Virtualization
|
||||
---
|
||||
|
||||
|
||||
VMs on Qubes OS have access to virtualized audio through the PulseAudio module.
|
||||
It consists of two parts:
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ ref: 59
|
|||
title: Networking
|
||||
---
|
||||
|
||||
|
||||
## Overall description
|
||||
|
||||
In Qubes, the standard Xen networking is used, based on backend driver in the driver domain and frontend drivers in VMs. In order to eliminate layer 2 attacks originating from a compromised VM, routed networking is used instead of the default bridging of `vif` devices and NAT is applied at each network hop. The default *vif-route* script had some deficiencies (requires `eth0` device to be up, and sets some redundant iptables rules), therefore the custom *vif-route-qubes* script is used.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,6 @@ ref: 55
|
|||
title: Security-critical Code
|
||||
---
|
||||
|
||||
|
||||
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.
|
||||
This code can be thought of as the Trusted Computing Base (TCB) of Qubes OS.
|
||||
|
|
@ -69,4 +68,3 @@ This means that we must trust at least some of the vendors that supply the code
|
|||
(We don't have to trust *all* of them, but we at least have to trust the few that provide the apps we use in the most critical domains.)
|
||||
In practice, we trust the software provided by the [Fedora Project](https://getfedora.org/).
|
||||
This software is signed by Fedora distribution keys, so it is also critical that the tools used in domains for software updates (`dnf` and `rpm`) are trustworthy.
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,6 @@ ref: 210
|
|||
title: 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.
|
||||
|
||||
Qubes also provides features that make it easy and convenient to run these multiple domains, such as seamless GUI integration into one common desktop, secure clipboard copy and paste between domains, secure file transfer between domains, disposable VMs, and much more. Qubes also provides an advanced networking infrastructure that allows for the creation of multiple network VMs which isolate all the world-facing networking stacks and proxy VMs which can be used for advanced VPN configurations and tunneling over untrusted connections.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ ref: 57
|
|||
title: Storage Pools
|
||||
---
|
||||
|
||||
|
||||
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.
|
||||
See [here](https://dev.qubes-os.org/projects/core-admin/en/latest/qubes-storage.html)
|
||||
|
|
|
|||
|
|
@ -10,7 +10,6 @@ ref: 58
|
|||
title: Template Implementation
|
||||
---
|
||||
|
||||
|
||||
Every VM has 4 block devices connected:
|
||||
|
||||
- **xvda** – base root device (/) – details described below
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue