Clarify use of Updates Proxy when updating and installing software

Merge branch 'pr-1459'
This commit is contained in:
unman 2025-05-15 11:08:33 +00:00
commit b87aaed495
No known key found for this signature in database
GPG key ID: BB52274595B71262
3 changed files with 39 additions and 18 deletions

View file

@ -68,18 +68,39 @@ will appear in the Applications Menu. (If you encounter problems, see
## Installing software from other sources ## Installing software from other sources
Some software is not available from the default repositories and must be
downloaded and installed from another source. Depending on the installation method,
you may either use the updates proxy or direct networking.
### Using the updates proxy
If you are still using the distribution package manager, updates will likely still
work over the updates proxy without needing to give the TemplateVM direct network access.
If you are using another installation method fetching remote resources, you might still
be able to use the updates proxy by making the tools aware of the proxy. For many tools,
it is enough to export the following environment variables in your shell session before
proceeding:
```sh
$ export HTTP_PROXY=http://127.0.0.1:8082 http_proxy=$HTTP_PROXY \
HTTPS_PROXY=$HTTP_PROXY https_proxy=$HTTPS_PROXY \
ALL_PROXY=$HTTP_PROXY all_proxy=$ALL_PROXY \
NO_PROXY=127.0.0.1 no_proxy=$NO_PROXY
```
### Using direct networking
**Warning:** This method gives your template direct network access, which is **Warning:** This method gives your template direct network access, which is
[risky](#why-dont-templates-have-network-access). This method is **not** [risky](#why-dont-templates-have-normal-network-access). This method is **not**
recommended for trusted templates. Moreover, depending on how you install this recommended for trusted templates. Moreover, depending on how you install this
software, it may not get updated automatically when you [update Qubes software, it may not get updated automatically when you [update Qubes
normally](/doc/how-to-update/), which means you may have to update it manually normally](/doc/how-to-update/), which means you may have to update it manually
yourself. yourself.
Some software is not available from the default repositories and must be This method assumes that you are trying to follow instructions to install some piece
downloaded and installed from another source. This method assumes that you're of software in a normal operating system, except *that* operating system is running as a
trying to follow the instructions to install some piece of software in a normal template in Qubes OS.
operating system, except that operating system is running as a template in
Qubes OS.
1. (Recommended) Clone the desired template (since this new template will 1. (Recommended) Clone the desired template (since this new template will
probably be less trusted than the original). probably be less trusted than the original).
@ -140,25 +161,25 @@ If things are still not working as expected:
Please see [How to Update](/doc/how-to-update/). Please see [How to Update](/doc/how-to-update/).
## Why don't templates have network access? ## Why don't templates have normal network access?
In order to protect you from performing risky activities in templates, they do In order to protect you from performing risky activities in templates, they do
not have normal network access by default. Instead, templates use an [updates not have normal network access by default. Instead, templates use an [updates
proxy](#updates-proxy) that allows you to install and update software using proxy](#updates-proxy) which allows you to install and update software using
the distribution package manager without giving the template direct network the distribution's package manager over the proxy connection.
access.**The updates proxy is already setup to work automatically **The updates proxy is already set up to work automatically out-of-the-box and
out-of-the-box and requires no special action from you.** Most users should requires no special action from you.**
simply follow the normal instructions for [installing software from default Most users should simply follow the normal instructions for [installing software
repositories](#installing-software-from-default-repositories) and from default repositories](#installing-software-from-default-repositories)
[updating](/doc/how-to-update/) software. If your software is not available in and [updating](/doc/how-to-update/) software. If your software is not available
the default repositories, see [installing software from other in the default repositories, see [installing software from other
sources](#installing-software-from-other-sources). sources](#installing-software-from-other-sources).
## Advanced ## Advanced
The following sections cover advanced topics pertaining to installing and The following sections cover advanced topics pertaining to installing and
updating software in domUs. updating software in qubes.
### Testing repositories ### Testing repositories

View file

@ -33,7 +33,7 @@ However, you can also start the tool manually by selecting it in the Application
<div class="alert alert-info" role="alert"> <div class="alert alert-info" role="alert">
<i class="fa fa-question-circle"></i> <i class="fa fa-question-circle"></i>
For information about how templates download updates, please see <a href="/doc/how-to-install-software/#why-dont-templates-have-network-access">Why don't templates have network access?</a> and the <a href="/doc/how-to-install-software/#updates-proxy">Updates proxy</a>. For information about how templates download updates, please see <a href="/doc/how-to-install-software/#why-dont-templates-have-normal-network-access">Why don't templates have normal network access?</a> and the <a href="/doc/how-to-install-software/#updates-proxy">Updates proxy</a>.
</div> </div>
By default, most qubes that are connected to the internet will periodically check for updates for their parent templates. You can check the date of the last update check in the "last checked" column. If updates are available for any qube, you will receive a notification as described above, and in the "Updates available" column you will see "YES" for that qube(s). If the update check did not find any new updates, "NO" will appear in the column. Respectively, for qubes that are no longer supported, "OBSOLETE" will be displayed. However, if you have any templates that do *not* have any online child qubes, you will *not* receive update notifications for them. By default, after a week, if updates for a given qube have not been checked, the value in the "Updates available" column will be set to "MAYBE". By default, most qubes that are connected to the internet will periodically check for updates for their parent templates. You can check the date of the last update check in the "last checked" column. If updates are available for any qube, you will receive a notification as described above, and in the "Updates available" column you will see "YES" for that qube(s). If the update check did not find any new updates, "NO" will appear in the column. Respectively, for qubes that are no longer supported, "OBSOLETE" will be displayed. However, if you have any templates that do *not* have any online child qubes, you will *not* receive update notifications for them. By default, after a week, if updates for a given qube have not been checked, the value in the "Updates available" column will be set to "MAYBE".

View file

@ -145,7 +145,7 @@ After installing a fresh template, we recommend performing the following steps:
For information about how templates access the network, please see [Why dont For information about how templates access the network, please see [Why dont
templates have network templates have network
access?](/doc/how-to-install-software/#why-dont-templates-have-network-access) access?](/doc/how-to-install-software/#why-dont-templates-have-normal-network-access)
and the [Updates proxy](/doc/how-to-install-software/#updates-proxy). and the [Updates proxy](/doc/how-to-install-software/#updates-proxy).
## Updating ## Updating