mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2025-10-15 03:50:42 -04:00
Fix formattings and other issues
See issue 8180.
This commit is contained in:
Tobias Killer
parent
810901e5d6
commit
0cfd755295
25 changed files with 114 additions and 76 deletions
|
|
@ -146,7 +146,7 @@ You can also modify sources somehow if you wish. Here are some basic steps:
|
|||
|
||||
|
||||
|
||||
- You can also set GIT_PREFIX=“marmarek/qubes-” to use marmarek’s repo instead of “mainstream” - it contains newer (but less tested) versions
|
||||
- You can also set GIT_PREFIX=“marmarek/qubes-” to use marmarek’s repo instead of “mainstream” - it contains newer (but less tested) versions
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -111,6 +111,7 @@ If you’re submitting a patch via GitHub (or a similar Git server), please sign
|
|||
|
||||
|
||||
3. (Optional) Create signed tags. Signed commits are totally sufficient to contribute to Qubes OS. However, if you have commits which are not signed and you do not want to change them, you can create a signed tag for the commit and push it before the check.
|
||||
|
||||
This is useful for example, if you have a commit back in the git history which you like to sign now without rewriting the history.
|
||||
|
||||
.. code:: bash
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ General typographic conventions
|
|||
|
||||
- **Maintain a decent amount of horizontal spacing**, e.g. add a space after ``if`` or before ``{`` in C, and similar in other languages. Whether and where to also use spaces within expressions, such as (x*2+5) vs. (x * 2 + 5) is left to the developer’s judgment. Do not put spaces immediately after or before the brackets in expressions, so avoid constructs like this: ``if ( condition )`` and use ones like this: ``if (condition)`` instead.
|
||||
|
||||
- **Use single new lines** (‘\n’ aka LF) in any non-Windows source code. On Windows, exceptionally, use the CRLF line endings (–). This will allow the source code to be easily viewable in various Windows-based programs.
|
||||
- **Use single new lines** (‘\\n’ aka LF) in any non-Windows source code. On Windows, exceptionally, use the CRLF line endings (–). This will allow the source code to be easily viewable in various Windows-based programs.
|
||||
|
||||
- **Use descriptive names for variables and functions**! Really, at a time when most editors have auto-completion features, there is no excuse for using short variable names.
|
||||
|
||||
|
|
|
|||
|
|
@ -61,6 +61,7 @@ How to Send Patches
|
|||
If you want to :ref:`contribute code <introduction/contributing:contributing code>` to the project, there are two ways. Whichever method you choose, you must :doc:`sign your code </developer/code/code-signing>` before it can be accepted.
|
||||
|
||||
- **Preferred**: Use GitHub’s `fork & pull requests <https://guides.github.com/activities/forking/>`__.
|
||||
|
||||
Opening a pull request on GitHub greatly eases the code review and tracking process. In addition, especially for bigger changes, it’s a good idea to send a message to the :ref:`qubes-devel mailing list <introduction/support:qubes-devel>` in order to notify people who do not receive GitHub notifications.
|
||||
|
||||
- Send a patch to the :ref:`qubes-devel mailing list <introduction/support:qubes-devel>` (``git format-patch``).
|
||||
|
|
|
|||
|
|
@ -199,11 +199,11 @@ Services called by dom0 to provide some VM configuration:
|
|||
|
||||
|
||||
|
||||
- ``xdgicon:NAME`` - search for NAME in standard icons theme
|
||||
- ``xdgicon:NAME`` - search for NAME in standard icons theme
|
||||
|
||||
- ``-`` - get icon data from stdin (the caller), can be prefixed with format name, for example ``png:-``
|
||||
- ``-`` - get icon data from stdin (the caller), can be prefixed with format name, for example ``png:-``
|
||||
|
||||
- file name
|
||||
- file name
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -225,13 +225,13 @@ There are many cases where a user wants to perform an action on more than one fi
|
|||
|
||||
|
||||
|
||||
- Click Folder One
|
||||
- Click Folder One
|
||||
|
||||
- Click Folder Two
|
||||
- Click Folder Two
|
||||
|
||||
- Click Folder Three
|
||||
- Click Folder Three
|
||||
|
||||
- Click Folder Four
|
||||
- Click Folder Four
|
||||
|
||||
|
||||
|
||||
|
|
@ -304,4 +304,4 @@ Learning to make well designing intuitive interfaces and software is specialized
|
|||
|
||||
|
||||
.. |checkmark| image:: /attachment/doc/checkmark.png
|
||||
.. |redx| image:: /attachment/doc/red_x.png
|
||||
.. |redx| image:: /attachment/doc/red_x.png
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@ Security Notes
|
|||
- PV VMs migrated from 3.2 to 4.0-rc4 or later are automatically set to PVH mode in order to protect against Meltdown (see `QSB #37 <https://github.com/QubesOS/qubes-secpack/blob/master/QSBs/qsb-037-2018.txt>`__). However, PV VMs migrated from any earlier 4.0 release candidate (RC1, RC2, or RC3) are not automatically set to PVH mode. These must be set manually.
|
||||
|
||||
- The following steps may need to be applied in dom0 and Fedora 26 TemplateVMs in order to receive updates (see `#3737 <https://github.com/QubesOS/qubes-issues/issues/3737>`__).
|
||||
|
||||
Steps for dom0 updates:
|
||||
|
||||
1. Open the Qubes Menu by clicking on the “Q” icon in the top-left corner of the screen.
|
||||
|
|
|
|||
|
|
@ -152,11 +152,11 @@ it easy to set the policy using current mechanism.
|
|||
- ``dom0``
|
||||
- `-`
|
||||
- `-`
|
||||
- ``<property-name> <full-value-as-in-property.Get>``
|
||||
- ``<property-name> <full-value-as-in-property.Get>\n``
|
||||
- Get all the properties in one call. Each property is returned on a separate line and use the same value encoding as property.Get method, with an exception that newlines are encoded as literal ``\n`` and literal ``\`` are encoded as ``\\``.
|
||||
* - ``admin.property.GetDefault``
|
||||
- ``dom0``
|
||||
- propety
|
||||
- property
|
||||
- `-`
|
||||
- ``type={str|int|bool|vm|label|list} <value>``
|
||||
- Type ``list`` is added in R4.1. Values are of type ``str`` and each entry is suffixed with newline character.
|
||||
|
|
@ -339,13 +339,7 @@ it easy to set the policy using current mechanism.
|
|||
- device
|
||||
- assignment-serialization
|
||||
- `-`
|
||||
- ``device`` is in form ``<backend-name>+<device-ident>`` optional options given in ``key=value`` format, separated with spaces; options can include ``persistent=True`` to "persistently" attach the device (default is temporary)
|
||||
* - ``admin.vm.device.<class>.Detach``
|
||||
- vm
|
||||
- device
|
||||
- `-`
|
||||
- `-`
|
||||
- ``device`` is in form ``<backend-name>+<device-ident>``
|
||||
- ``device`` is in form ``<backend-name>+<device-ident>``; optional options given in ``key=value`` format, separated with spaces; options can include ``persistent=True`` to "persistently" attach the device (default is temporary)
|
||||
* - ``admin.vm.device.<class>.Detach``
|
||||
- vm
|
||||
- device
|
||||
|
|
@ -355,9 +349,9 @@ it easy to set the policy using current mechanism.
|
|||
* - ``admin.vm.device.<class>.Assign``
|
||||
- vm
|
||||
- device
|
||||
- assignement-serialization
|
||||
- assignment-serialization
|
||||
- `-`
|
||||
- ``device`` is in form ``<backend-name>+<device-ident>`` ``assignment-serialization`` is specified in the section Device Serialization.
|
||||
- ``device`` is in form ``<backend-name>+<device-ident>``; ``assignment-serialization`` is specified in the section Device Serialization.
|
||||
* - ``admin.vm.device.<class>.Unassign``
|
||||
- vm
|
||||
- device
|
||||
|
|
@ -371,7 +365,7 @@ it easy to set the policy using current mechanism.
|
|||
- `-`
|
||||
- ``device`` is in form ``<backend-name>+<device-ident>``
|
||||
* - ``admin.vm.deviceclass.List``
|
||||
- `dom0`
|
||||
- ``dom0``
|
||||
- `-`
|
||||
- `-`
|
||||
- ``<deviceclass>\n``
|
||||
|
|
@ -387,7 +381,7 @@ it easy to set the policy using current mechanism.
|
|||
- device-ident
|
||||
- `-`
|
||||
- ``<device-ident> <assignment-serialization>\n``
|
||||
- optional service argument may be used to get info about a single device, ``assignement-serialization`` is specified in the section Device Serialization.
|
||||
- optional service argument may be used to get info about a single device, ``assignment-serialization`` is specified in the section Device Serialization.
|
||||
* - ``admin.vm.device.<class>.Attached``
|
||||
- vm
|
||||
- device-ident
|
||||
|
|
@ -410,7 +404,7 @@ it easy to set the policy using current mechanism.
|
|||
- ``dom0``
|
||||
- pool
|
||||
- `-`
|
||||
- ``<property>=<value>``
|
||||
- ``<property>=<value>\n``
|
||||
-
|
||||
* - ``admin.pool.Add``
|
||||
- ``dom0``
|
||||
|
|
@ -566,7 +560,7 @@ it easy to set the policy using current mechanism.
|
|||
- vm
|
||||
- `-`
|
||||
- `-`
|
||||
- ``<state-property>=<value>``
|
||||
- ``<state-property>=<value>\n``
|
||||
- state properties: ``power_state``, ``mem``, ``mem_static_max``, ``cputime``
|
||||
* - ``admin.vm.Start``
|
||||
- vm
|
||||
|
|
|
|||
|
|
@ -113,7 +113,10 @@ Answering an RPC call
|
|||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
In other for a RPC call to be answered in the target VM, a file in either of the following locations must exist, containing the file name of the program that will be invoked, or being that program itself – in which case it must have executable permission set (``chmod +x``): - ``/etc/qubes-rpc/RPC_ACTION_NAME`` when you make it in the template qube; - ``/usr/local/etc/qubes-rpc/RPC_ACTION_NAME`` for making it only in an app qube.
|
||||
In other for a RPC call to be answered in the target VM, a file in either of the following locations must exist, containing the file name of the program that will be invoked, or being that program itself – in which case it must have executable permission set (``chmod +x``):
|
||||
|
||||
- ``/etc/qubes-rpc/RPC_ACTION_NAME`` when you make it in the template qube;
|
||||
- ``/usr/local/etc/qubes-rpc/RPC_ACTION_NAME`` for making it only in an app qube.
|
||||
|
||||
The source VM name can then be accessed in the server process via ``QREXEC_REMOTE_DOMAIN`` environment variable. (Note the source VM has *no* control over the name provided in this variable–the name of the VM is provided by dom0, and so is trusted.)
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ What is Qubes OS?
|
|||
-----------------
|
||||
|
||||
Qubes OS is a free and open-source, security-oriented operating system for
|
||||
single-user desktop computing. Qubes OS `leverages Xen-based virtualization <https://wiki.xen.org/wiki/Xen_Project_Software_Overview>`__ to allow for the creation and management of isolated compartments called :ref:`qubes <user/reference/glossary:qube>`.
|
||||
single-user desktop computing. Qubes OS leverages `Xen-based virtualization <https://wiki.xen.org/wiki/Xen_Project_Software_Overview>`__ to allow for the creation and management of isolated compartments called :ref:`qubes <user/reference/glossary:qube>`.
|
||||
|
||||
|
||||
These qubes, which are implemented as :ref:`virtual machines (VMs)<user/reference/glossary:vm>`, have specific:
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ Window Management
|
|||
|
||||
You can set each window’s position and size like this:
|
||||
|
||||
.. code:: python
|
||||
.. code:: text
|
||||
|
||||
Right click title bar --> More actions --> Special window settings...
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ By default, VMs kernels are provided by dom0. (See :ref:`here <user/advanced-top
|
|||
|
||||
To select which kernel a given VM will use, you can either use Qubes Manager (VM settings, advanced tab), or the ``qvm-prefs`` tool:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[user@dom0 ~]$ qvm-prefs -s my-appvm kernel
|
||||
Missing kernel version argument!
|
||||
|
|
@ -40,7 +40,7 @@ To select which kernel a given VM will use, you can either use Qubes Manager (VM
|
|||
|
||||
To check/change the default kernel you can either go to “Global settings” in Qubes Manager, or use the ``qubes-prefs`` tool:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[user@dom0 ~]$ qubes-prefs
|
||||
clockvm : sys-net
|
||||
|
|
@ -54,7 +54,7 @@ To check/change the default kernel you can either go to “Global settings” in
|
|||
|
||||
To view kernel options, you can use the GUI VM Settings tool; to view and change them, use ``qvm-prefs`` commandline tool:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[user@dom0 ~]$ qvm-prefs -g work kernelopts
|
||||
nopat
|
||||
|
|
@ -67,7 +67,7 @@ Installing different kernel using Qubes kernel package
|
|||
|
||||
VM kernels are packaged by the Qubes team in the ``kernel-qubes-vm`` packages. Generally, the system will keep the three newest available versions. You can list them with the ``rpm`` command:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[user@dom0 ~]$ rpm -qa 'kernel-qubes-vm*'
|
||||
kernel-qubes-vm-3.18.10-2.pvops.qubes.x86_64
|
||||
|
|
@ -79,7 +79,7 @@ If you want a more recent version, you can check the ``qubes-dom0-unstable`` rep
|
|||
|
||||
To check available versions in the ``qubes-dom0-unstable`` repository:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[user@dom0 ~]$ sudo qubes-dom0-update --enablerepo=qubes-dom0-unstable --action=list kernel-qubes-vm
|
||||
Using sys-firewall as UpdateVM to download updates for Dom0; this may take some time...
|
||||
|
|
@ -100,7 +100,7 @@ To check available versions in the ``qubes-dom0-unstable`` repository:
|
|||
|
||||
Installing a new version from ``qubes-dom0-unstable`` repository:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[user@dom0 ~]$ sudo qubes-dom0-update --enablerepo=qubes-dom0-unstable kernel-qubes-vm
|
||||
Using sys-firewall as UpdateVM to download updates for Dom0; this may take some time...
|
||||
|
|
@ -165,7 +165,7 @@ It is possible to package a kernel installed in dom0 as a VM kernel. This makes
|
|||
|
||||
To prepare such a VM kernel, you need to install the ``qubes-kernel-vm-support`` package in dom0 and also have matching kernel headers installed (``kernel-devel`` package in the case of a Fedora kernel package). You can install requirements using ``qubes-dom0-update``:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[user@dom0 ~]$ sudo qubes-dom0-update qubes-kernel-vm-support kernel-devel
|
||||
Using sys-firewall as UpdateVM to download updates for Dom0; this may take some time...
|
||||
|
|
@ -209,7 +209,7 @@ To prepare such a VM kernel, you need to install the ``qubes-kernel-vm-support``
|
|||
|
||||
Then you can call the ``qubes-prepare-vm-kernel`` tool to actually package the kernel. The first parameter is kernel version (exactly as seen by the kernel), the second one (optional) is short name. This is visible in Qubes Manager and the ``qvm-prefs`` tool.
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[user@dom0 ~]$ sudo qubes-prepare-vm-kernel 4.1.9-6.pvops.qubes.x86_64 4.1.qubes
|
||||
--> Building files for 4.1.9-6.pvops.qubes.x86_64 in /var/lib/qubes/vm-kernels/4.1.qubes
|
||||
|
|
@ -244,7 +244,7 @@ Using kernel installed in the VM
|
|||
|
||||
Both debian-9 and fedora-26 templates already have grub and related tools preinstalled so if you want to use one of the distribution kernels, all you need to do is clone either template to a new one, then:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
qvm-prefs <clonetemplatename> virt_mode hvm
|
||||
qvm-prefs <clonetemplatename> kernel ''
|
||||
|
|
@ -261,7 +261,7 @@ Install whatever kernel you want. You need to also ensure you have the ``kernel-
|
|||
|
||||
If you are using a distribution kernel package (``kernel`` package), the initramfs and kernel modules may be handled automatically. If you are using a manually built kernel, you need to handle this on your own. Take a look at the ``dkms`` documentation, especially the ``dkms autoinstall`` command may be useful. If you did not see the ``kernel`` install rebuild your initramfs, or are using a manually built kernel, you will need to rebuild it yourself. Replace the version numbers in the example below with the ones appropriate to the kernel you are installing:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo dracut -f /boot/initramfs-4.15.14-200.fc26.x86_64.img 4.15.14-200.fc26.x86_64
|
||||
|
||||
|
|
@ -269,7 +269,7 @@ If you are using a distribution kernel package (``kernel`` package), the initram
|
|||
|
||||
Once the kernel is installed, you need to setup ``grub2`` by running:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo grub2-install /dev/xvda
|
||||
|
||||
|
|
@ -277,7 +277,7 @@ Once the kernel is installed, you need to setup ``grub2`` by running:
|
|||
|
||||
Finally, you need to create a GRUB configuration. You may want to adjust some settings in ``/etc/default/grub``; for example, lower ``GRUB_TIMEOUT`` to speed up VM startup. Then, you need to generate the actual configuration. In Fedora it can be done using the ``grub2-mkconfig`` tool:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo grub2-mkconfig -o /boot/grub2/grub.cfg
|
||||
|
||||
|
|
@ -285,7 +285,7 @@ Finally, you need to create a GRUB configuration. You may want to adjust some se
|
|||
|
||||
You can safely ignore this error message:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: output
|
||||
|
||||
grub2-probe: error: cannot find a GRUB drive for /dev/mapper/dmroot. Check your device.map
|
||||
|
||||
|
|
@ -319,7 +319,7 @@ Using a distribution kernel package the initramfs and kernel modules should be h
|
|||
|
||||
Install distribution kernel image, kernel headers and the grub.
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo apt install linux-image-amd64 linux-headers-amd64 grub2 qubes-kernel-vm-support
|
||||
|
||||
|
|
@ -327,7 +327,7 @@ Install distribution kernel image, kernel headers and the grub.
|
|||
|
||||
If you are doing that on a qube based on “Debian Minimal” template, a grub gui will popup during the installation, asking you where you want to install the grub loader. You must select ``/dev/xvda`` (check the box using the space bar, and validate your choice with “Enter”.) If this popup does not appear during the installation, you must manually setup ``grub2`` by running:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo grub-install /dev/xvda
|
||||
|
||||
|
|
@ -381,7 +381,7 @@ Run DKMS. Replace this with actual kernel version.
|
|||
|
||||
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo dkms autoinstall -k <kernel-version>
|
||||
|
||||
|
|
@ -390,7 +390,7 @@ For example.
|
|||
|
||||
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo dkms autoinstall -k 4.19.0-6-amd64
|
||||
|
||||
|
|
@ -399,14 +399,14 @@ Update initramfs.
|
|||
|
||||
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo update-initramfs -u
|
||||
|
||||
|
||||
The output should look like this:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
$ sudo dkms autoinstall -k 3.16.0-4-amd64
|
||||
|
||||
|
|
|
|||
|
|
@ -349,7 +349,7 @@ As in the example above, it creates a qube and sets its properties.
|
|||
|
||||
You can set properties of an existing qube:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
my preferences:
|
||||
qvm.prefs:
|
||||
|
|
@ -364,7 +364,7 @@ You can set properties of an existing qube:
|
|||
^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
services in my qube:
|
||||
qvm.service:
|
||||
|
|
@ -388,7 +388,7 @@ This enables, disables, or sets to default, services as in ``qvm-service``.
|
|||
|
||||
Ensures the specified qube is running:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
qube is running:
|
||||
qvm.running:
|
||||
|
|
|
|||
|
|
@ -20,14 +20,14 @@ Qubes 4.0 is more flexible than earlier versions about placing different VMs on
|
|||
|
||||
You can query qvm-pool to list available storage drivers:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
qvm-pool --help-drivers
|
||||
|
||||
|
||||
qvm-pool driver explanation:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
<file> refers to using a simple file for image storage and lacks a few features.
|
||||
<file-reflink> refers to storing images on a filesystem supporting copy on write.
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ The upgrade may take several hours, and will download several gigabytes of data.
|
|||
|
||||
In place upgrade is a complex operation. For this reason, we provide a ``qubes-dist-upgrade`` tool to handle all the necessary steps automatically. You can install it with the following command in the dom0 terminal:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo qubes-dom0-update -y qubes-dist-upgrade
|
||||
|
||||
|
|
@ -47,7 +47,7 @@ The upgrade consists of seven stages — six before restarting the system — la
|
|||
|
||||
Full list of options can be obtained with ``qubes-dist-upgrade --help``:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: output
|
||||
|
||||
Usage: qubes-dist-upgrade [OPTIONS]...
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ Full list of options can be obtained with ``qubes-dist-upgrade --help``:
|
|||
|
||||
After installing the tool, upgrade can be performed all at once with:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo qubes-dist-upgrade --all
|
||||
|
||||
|
|
@ -94,7 +94,7 @@ Alternatively, each upgrade stage can be started separately (see the list of opt
|
|||
|
||||
After completing “STAGE 0” through “STAGE 5”, restart the system. Then perform the final step:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo qubes-dist-upgrade --resync-appmenus-features
|
||||
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ The upgrade may take several hours, and will download several gigabytes of data.
|
|||
|
||||
In place upgrade is a complex operation. For this reason, we provide a ``qubes-dist-upgrade`` tool to handle all the necessary steps automatically. You can install it with the following command in the dom0 terminal:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo qubes-dom0-update -y qubes-dist-upgrade
|
||||
|
||||
|
|
@ -66,7 +66,7 @@ The upgrade consists of six stages — three before restarting the system — la
|
|||
|
||||
Full list of options can be obtained with ``qubes-dist-upgrade --help``:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: output
|
||||
|
||||
Usage: qubes-dist-upgrade [OPTIONS]...
|
||||
|
||||
|
|
@ -102,7 +102,7 @@ Full list of options can be obtained with ``qubes-dist-upgrade --help``:
|
|||
|
||||
After installing the tool, before-reboot stages can be performed at once with:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo qubes-dist-upgrade --all-pre-reboot
|
||||
|
||||
|
|
@ -114,7 +114,7 @@ Alternatively, each upgrade stage can be started separately (see the list of opt
|
|||
|
||||
After completing “STAGE 1” through “STAGE 3”, restart the system. Then perform the final steps:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
sudo qubes-dist-upgrade --all-post-reboot
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ The current Qubes-certified models are listed below in reverse chronological ord
|
|||
- :doc:`Certification details </user/hardware/certified-hardware/nitropad-v56/>`
|
||||
* - `NovaCustom <https://novacustom.com/>`__
|
||||
- `V56 Series <https://novacustom.com/product/v56-series/>`__
|
||||
- :doc:`Certification details </user/hardware/certified-hardware/novacustom-v54-series/>`
|
||||
- :doc:`Certification details </user/hardware/certified-hardware/novacustom-v56-series/>`
|
||||
* - `Nitrokey <https://www.nitrokey.com/>`__
|
||||
- `NitroPC Pro 2 <https://shop.nitrokey.com/shop/nitropc-pro-2-523>`__
|
||||
- :doc:`Certification details </user/hardware/certified-hardware/nitropc-pro-2/>`
|
||||
|
|
@ -55,7 +55,7 @@ The current Qubes-certified models are listed below in reverse chronological ord
|
|||
- `NitroPad T430 <https://shop.nitrokey.com/shop/nitropad-t430-119>`__
|
||||
- :doc:`Certification details </user/hardware/certified-hardware/nitropad-t430/>`
|
||||
* - `Nitrokey <https://www.nitrokey.com/>`__
|
||||
- `NitroPad X230 <https://shop.nitrokey.com/shop/product/nitropad-t430-119>`__
|
||||
- `NitroPad X230 <https://shop.nitrokey.com/shop/product/nitropad-x230-67>`__
|
||||
- :doc:`Certification details </user/hardware/certified-hardware/nitropad-x230/>`
|
||||
* - `Insurgo <https://insurgo.ca/>`__
|
||||
- `PrivacyBeast X230 <https://insurgo.ca/produit/qubesos-certified-privacybeast_x230-reasonably-secured-laptop/>`__
|
||||
|
|
|
|||
|
|
@ -201,6 +201,7 @@ When you install a new template or :ref:`upgrade <user/how-to-guides/how-to-upda
|
|||
- If your only keyboard and mouse are *not* connected through a :doc:`USB qube </user/advanced-topics/usb-qubes>`, or that USB qube is *not* a disposable, then shut down all disposables. In the App Menu, go to Qubes Tools, then click on Qube Manager. In the Qube Manager, find your disposable template(s). (By default, they end in ``-dvm``.) Right click, hover over Template, then click on the new template. Repeat for each disposable template.
|
||||
|
||||
- If your only keyboard or mouse *are* connected through a USB qube, and that USB qube *is* a disposable, then you will have to enter a special command that shuts down all of your qubes, switches the USB qube’s disposable template to the new template, then starts the USB qube again. In order to avoid being locked out of your system, you must be very careful to enter this command without typos and with the correct substitutions.
|
||||
|
||||
In the App Menu, click on Terminal Emulator. Type the command below, substituting ``<SYS_USB_DISPOSABLE_TEMPLATE>`` with the name of the disposable template on which ``sys-usb`` is based, ``<NEW_TEMPLATE>`` with the name of the new template, and ``<USB_QUBE>`` with the name of your USB qube. Other than these substitutions, make sure to enter the command exactly as written.
|
||||
|
||||
.. code:: bash
|
||||
|
|
@ -249,7 +250,7 @@ Once an app qube has been created, any changes in its ``/home``, ``/usr/local``,
|
|||
* - :ref:`template <user/reference/glossary:template>`
|
||||
- N/A (templates cannot be based on templates)
|
||||
- everything
|
||||
* - :ref:`app qubes <user/reference/glossary:app qube>`:superscript:`3`
|
||||
* - :ref:`app qube <user/reference/glossary:app qube>`:superscript:`3`
|
||||
- ``/etc/skel`` to ``/home``; ``/usr/local.orig`` to ``/usr/local``
|
||||
- ``/rw`` (includes ``/home``, ``/usr/local``, and ``bind-dirs``)
|
||||
* - :ref:`disposable <user/reference/glossary:disposable>`
|
||||
|
|
|
|||
|
|
@ -143,7 +143,7 @@ This will allow you to install the Qubes Windows Tools on Windows 10 both as a S
|
|||
|
||||
**Note:** If this property is not set or set to a wrong value, files copied to this VM are stored in the folder
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
C:\Windows\System32\config\systemprofile\Documents\QubesIncoming\<source_VM>
|
||||
|
||||
|
|
@ -507,9 +507,9 @@ If a specific component is malfunctioning, you can increase its log verbosity as
|
|||
* - network-setup
|
||||
- Service that sets up network parameters according to VM’s configuration.
|
||||
* - prepare-volume
|
||||
- Utility that initializes and formats the disk backed by private.img file. It’s registered to run on next system boot during QWT setup, if that feature is selected (it can’t run during the setup because Xen block device drivers are not yet active). It in turn registers move-profiles (see below) to run at early boot.
|
||||
- Utility that initializes and formats the disk backed by ``private.img`` file. It’s registered to run on next system boot during QWT setup, if that feature is selected (it can’t run during the setup because Xen block device drivers are not yet active). It in turn registers move-profiles (see below) to run at early boot.
|
||||
* - relocate-dir
|
||||
- Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: c:\move-profiles.log (it can’t use our common logger library so none of the log settings apply).
|
||||
- Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: ``c:\move-profiles.log`` (it can’t use our common logger library so none of the log settings apply).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -536,9 +536,9 @@ If a specific component is malfunctioning, you can increase its log verbosity as
|
|||
* - network-setup
|
||||
- Service that sets up network parameters according to VM’s configuration.
|
||||
* - prepare-volume
|
||||
- Utility that initializes and formats the disk backed by private.img file. It’s registered to run on next system boot during QWT setup, if that feature is selected (it can’t run during the setup because Xen block device drivers are not yet active). It in turn registers move-profiles (see below) to run at early boot.
|
||||
- Utility that initializes and formats the disk backed by ``private.img`` file. It’s registered to run on next system boot during QWT setup, if that feature is selected (it can’t run during the setup because Xen block device drivers are not yet active). It in turn registers move-profiles (see below) to run at early boot.
|
||||
* - relocate-dir
|
||||
- Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: C:\\move-profiles.log (it can’t use our common logger library so none of the log settings apply).
|
||||
- Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: ``C:\move-profiles.log`` (it can’t use our common logger library so none of the log settings apply).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -100,8 +100,11 @@ Installation procedure:
|
|||
- Install on first disk.
|
||||
|
||||
- Windows license may be read from flash via root in dom0:
|
||||
|
||||
``strings < /sys/firmware/acpi/tables/MSDM``
|
||||
|
||||
Alternatively, you can also try a Windows 7 license key (as of 2018/11 they are still accepted for a free upgrade).
|
||||
|
||||
I first installed Windows and all updates, then entered the license key.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -106,7 +106,7 @@ Signature Verification Warnings
|
|||
|
||||
There should be none at the moment. If there was such a warning, it would look like this:
|
||||
|
||||
.. code::
|
||||
.. code:: text
|
||||
|
||||
W: A error occurred during the signature verification. The repository is not updated and the previous index files will be used. GPG error: http://deb.torproject.org stable Release: The following signatures were invalid: KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681
|
||||
|
||||
|
|
@ -120,7 +120,7 @@ In past various apt repositories were signed with expired key: `The Tor Project
|
|||
|
||||
You saw the following warning:
|
||||
|
||||
.. code::
|
||||
.. code:: text
|
||||
|
||||
W: A error occurred during the signature verification. The repository is not updated and the previous index files will be used. GPG error: http://deb.torproject.org stable Release: The following signatures were invalid: KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681
|
||||
|
||||
|
|
@ -139,7 +139,7 @@ Changed Configuration Files
|
|||
|
||||
If you see something like the following.
|
||||
|
||||
.. code::
|
||||
.. code:: text
|
||||
|
||||
Setting up ifupdown ...
|
||||
Configuration file /etc/network/interfaces
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ When a qube starts, a fixed amount of RAM is allocated to the graphics buffer ca
|
|||
|
||||
To determine if this is the problem affecting you, look at the Xorg log inside the Qube at ``/home/user/.local/share/xorg/Xorg.0.log`` for lines like the following:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[ 1623.988] (EE) DUMMYQBS(0): Unable to set up a virtual screen size of 3440x1440 with 17101 Kb of video memory available. Please increase the video memory size.
|
||||
|
||||
|
|
|
|||
|
|
@ -81,7 +81,24 @@ Or if you have already rebooted after the first stage install and have encounter
|
|||
|
||||
2. Press ‘3’ to go to the shell
|
||||
|
||||
3. Find and mount the EFI system partition. (replace ``/dev/sda`` with your disk name. If unsure, use the ``lsblk`` command to display a list of disks): ``fdisk -l /dev/sda | grep EFI`` The output should look like this: ``/dev/sda1 2048 1230847 1228800 600M EFI System`` Then mount it: ``mkdir -p /mnt/sysimage/boot/efi mount /dev/sda1 /mnt/sysimage/boot/efi``
|
||||
3. Find and mount the EFI system partition. (replace ``/dev/sda`` with your disk name. If unsure, use the ``lsblk`` command to display a list of disks):
|
||||
|
||||
.. code:: console
|
||||
|
||||
fdisk -l /dev/sda | grep EFI
|
||||
|
||||
The output should look like this:
|
||||
|
||||
.. code:: output
|
||||
|
||||
/dev/sda1 2048 1230847 1228800 600M EFI System
|
||||
|
||||
Then mount it:
|
||||
|
||||
.. code:: console
|
||||
|
||||
mkdir -p /mnt/sysimage/boot/efi
|
||||
mount /dev/sda1 /mnt/sysimage/boot/efi
|
||||
|
||||
4. Execute:
|
||||
|
||||
|
|
@ -107,7 +124,24 @@ Some firmware will not recognize the default Qubes EFI configuration. As such, i
|
|||
|
||||
2. Press ‘3’ to go to the shell
|
||||
|
||||
3. Find and mount the EFI system partition. (replace ``/dev/sda`` with your disk name. If unsure, use the ``lsblk`` command to display a list of disks): ``fdisk -l /dev/sda | grep EFI`` The output should look like this: ``/dev/sda1 2048 1230847 1228800 600M EFI System`` Then mount it: ``mkdir -p /mnt/sysimage/boot/efi mount /dev/sda1 /mnt/sysimage/boot/efi``
|
||||
3. Find and mount the EFI system partition. (replace ``/dev/sda`` with your disk name. If unsure, use the ``lsblk`` command to display a list of disks):
|
||||
|
||||
.. code:: console
|
||||
|
||||
fdisk -l /dev/sda | grep EFI
|
||||
|
||||
The output should look like this:
|
||||
|
||||
.. code:: output
|
||||
|
||||
/dev/sda1 2048 1230847 1228800 600M EFI System
|
||||
|
||||
Then mount it:
|
||||
|
||||
.. code:: console
|
||||
|
||||
mkdir -p /mnt/sysimage/boot/efi
|
||||
mount /dev/sda1 /mnt/sysimage/boot/efi
|
||||
|
||||
4. Copy ``grubx64.efi`` to the fallback path:
|
||||
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ Some packages will throw an error on installation in this situation. For example
|
|||
|
||||
One solution is to add a dummy interface to allow the package to install correctly:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: console
|
||||
|
||||
ip link add d0 type dummy
|
||||
ip addr add 192.168.0.1/24 dev d0
|
||||
|
|
@ -95,7 +95,7 @@ If the error occurs as a result of too little initial memory, increase the initi
|
|||
|
||||
For example:
|
||||
|
||||
.. code:: bash
|
||||
.. code:: text
|
||||
|
||||
[user@dom0 ~]$ sudo qubes-dom0-update --enablerepo=qubes-templates-itl qubes-template-debian-10
|
||||
Using sys-whonix as UpdateVM to download updates for Dom0; this may take some time...
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue