Update "How to Install Software"

- Improve intro
- Make key instruction steps harder to miss
- Add "Troubleshooting" section
- Move text on updating standalones to "Standalones and HVMs"
This commit is contained in:
Andrew David Wong 2021-06-20 20:43:43 -07:00
parent dffa3502fd
commit 92016a6ba1
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
2 changed files with 38 additions and 22 deletions

View File

@ -49,6 +49,15 @@ qvm-create --class StandaloneVM --label <label> --property virt_mode=hvm <vmname
(Note: Technically, `virt_mode=hvm` is not necessary for every standalone. (Note: Technically, `virt_mode=hvm` is not necessary for every standalone.
However, it makes sense if you want to use a kernel from within the VM.) However, it makes sense if you want to use a kernel from within the VM.)
## Updating standalones
When you create a standalone from a template, the standalone is a complete
clone of the template, including the entire filesystem. After the moment of
creation, the standalone becomes completely independent from the template.
Therefore, the standalone will not be updated merely by updating the template
from which it was originally cloned. Rather, it must be updated as an
independent qube. See [How to Update](/doc/how-to-update/).
## Creating an HVM ## Creating an HVM
### Using the GUI: ### Using the GUI:

View File

@ -12,15 +12,12 @@ ref: 189
title: How to Install Software title: How to Install Software
--- ---
When you install software in Qubes OS, you install it in your When you wish to install software in Qubes OS, you should generally install it
[templates](/doc/glossary/#template). in a [template](/doc/glossary/#template).
<div class="alert alert-info" role="alert"> Advanced users may also be interested in learning how to install software in
<i class="fa fa-info-circle"></i> [standalones](/doc/standalones-and-hvm/) and
<b>Note:</b> Advanced users may also be interested in learning how to install [dom0](/doc/how-to-install-software-in-dom0).
software in <a href="#standalones">standalones</a> and
<a href="/doc/how-to-install-software-in-dom0">dom0</a>.
</div>
## Instructions ## Instructions
@ -31,15 +28,15 @@ To permanently install new software in a template:
2. Start either a terminal (e.g. `gnome-terminal`) or a dedicated software 2. Start either a terminal (e.g. `gnome-terminal`) or a dedicated software
management application, such as `gpk-application`. management application, such as `gpk-application`.
3. Install software as normally instructed inside that operating system (e.g. 3. Install software as normally instructed inside that operating system, e.g.:
`sudo dnf install <PACKAGE_NAME>` on Fedora, `sudo apt install - Fedora: `sudo dnf install <PACKAGE_NAME>`
<PACKAGE_NAME>` on Debian). - Debian: `sudo apt install <PACKAGE_NAME>`
4. Shut down the template. 4. **Shut down the template. (Do not skip this step.)**
5. Restart all qubes based on the template so the changes can take effect. 5. **Restart all qubes based on the template. (Do not skip this step.)**
6. (Optional) In the relevant qubes' **Qube Settings**, go to the 6. (Recommended) In the relevant qubes' **Qube Settings**, go to the
**Applications** tab, select the new application(s) from the list, and press **Applications** tab, select the new application(s) from the list, and press
OK. These new shortcuts will appear in the Applications Menu. (If you OK. These new shortcuts will appear in the Applications Menu. (If you
encounter problems, see [here](/doc/app-menu-shortcut-troubleshooting/) for encounter problems, see [here](/doc/app-menu-shortcut-troubleshooting/) for
@ -47,6 +44,20 @@ To permanently install new software in a template:
![[The Applications tab in Qube Settings](/attachment/doc/r4.1-dom0-appmenu-select.png)](/attachment/doc/r4.1-dom0-appmenu-select.png) ![[The Applications tab in Qube Settings](/attachment/doc/r4.1-dom0-appmenu-select.png)](/attachment/doc/r4.1-dom0-appmenu-select.png)
## Troubleshooting
If things are still not working as expected:
- Review the [instructions](#instructions) very carefully, making sure you
follow each step.
- Make sure you **shut down the template after installing your software**.
- Make sure you **restart your app qube *after* shutting down your template**.
- If your software requires special files or directories to be persistent, and
you're an advanced user, see [Standalones and
HVMs](/doc/standalones-and-hvm/) and [How to Make Any File Persistent
(bind-dirs)](/doc/bind-dirs/).
- [Ask for help.](/doc/support/)
## How to update software ## How to update software
Please see [How to Update](/doc/how-to-update/). Please see [How to Update](/doc/how-to-update/).
@ -108,13 +119,10 @@ corresponding `deb` line in `/etc/apt/sources.list.d/qubes-r*.list`.
### Standalones ### Standalones
When you create a [standalone](/doc/standalone-and-hvm/) from a template, the The process for installing and updating software in
standalone is a complete clone of the template, including the entire [standalones](/doc/glossary/#standalone) is the same as described above for
filesystem. After the moment of creation, the standalone is completely templates, except no qubes are based on standalones, so there are no other
independent from the template. Therefore, it will not be updated when the qubes to restart.
template is updated. Rather, it must be updated individually. The process for
installing and updating software in standalones is the same as described above
for templates.
### RPMFusion for Fedora templates ### RPMFusion for Fedora templates
@ -383,4 +391,3 @@ chat app.
Note that the app will autostart only when the app qube starts. If you would Note that the app will autostart only when the app qube starts. If you would
like the app qube to autostart, select the "Start qube automatically on boot" like the app qube to autostart, select the "Start qube automatically on boot"
checkbox in the app qube's Qube Settings. checkbox in the app qube's Qube Settings.