{{Header}}
Download {{project_name_short}} Templates and Configure {{project_name_gateway_vm}}
and {{project_name_workstation_vm}}
.
'''1.''' Download speed notice.
This downloading procedure can take a long time to finish. Fast Internet connections take only a few minutes, while slow connections can take twenty minutes or more (it is far slower over Tor).
'''2.''' Download both [[{{project_name_gateway_short}}|{{project_name_gateway_long}}]] and [[{{project_name_workstation_short}}|{{project_name_workstation_long}}]] Templates.
In dom0
. [
The following ]qubes-dom0-update
command is:
* Optional.
* Useful because it has a progress indicator while the subsequent qubesctl
command does not. (Qubes feature request: [https://github.com/QubesOS/qubes-issues/issues/4215 add salt download progress indicator]) It very confusing to have a long running download command with progress bar, specifically over Tor.
* Insufficient by itself - the subsequent qubesctl
command that follow is mandatory as per [https://github.com/QubesOS/qubes-issues/issues/3447 phase out manual use of qubes-dom0-update by user / replace it by salt] and [[Dev/Qubes#salt]].
* --enablerepo=qubes-templates-community
:
** --enablerepo=qubes-templates-community
can be omitted if Qubes Community Templates Repository is already enabled in dom0
.
** Qubes Community Templates Repository should already be enabled as per Qubes default unless disabled by user, restored {{q_project_name_long}} from backup or some other edge case.
** Recommending to type --enablerepo=qubes-templates-community
is bad usability since users cannot copy from their VM browser where they are most likely reading this to dom0
. But too many people reported this issue. [https://forums.whonix.org/t/had-to-enable-community-templates-to-get-new-template/12489 had to enable Qubes templates community repository]
** If Qubes Community Templates Repository is not enabled in dom0
, explicitly add --enablerepo=qubes-templates-community
or enable through editing dom0 file /etc/yum.repos.d/qubes-templates.repo
.
{{Box|text=
In dom0
.
'''1.''' Open file /etc/yum.repos.d/qubes-templates.repo
in a text editor with root rights.
{{CodeSelect|code=
sudo nano /etc/yum.repos.d/qubes-templates.repo
}}
'''2.''' In section [qubes-templates-community]
, add the following.
{{CodeSelect|code=
enabled = 1
}}
'''3.''' Save.
'''4.''' Done.
Qubes Community Templates Repository has been enabled. Command line parameter --enablerepo=qubes-templates-community
should be no longer required.
'''5.''' Report.
Please report if step this was necessary for you!
}}
To download {{project_name_gateway_short}} and {{project_name_workstation_short}} run this command:
{{CodeSelect|code=
qvm-template install --enablerepo=qubes-templates-community whonix-gateway-17 whonix-workstation-17
}}
'''3.''' Configure {{project_name_gateway_vm}}
and {{project_name_workstation_vm}}
safely. [
* Do not interrupt the salt process once it has started or this can lead to an [https://groups.google.com/g/qubes-users/c/fwCqxENXguY unstable system].
* ]qubesctl
: Is a command by Qubes, not {{project_name_short}}. Advanced users could may look at [https://www.qubes-os.org/doc/salt/ Qubes salt management stack qubesctl
] for further information about qubesctl
and Qubes salt.
* If Templates were not previously downloaded already by using above qubes-dom0-update
command, then the qubesctl
command would also download both {{project_name_gateway_short}} and {{project_name_workstation_short}} Templates.
* Related source code files, reference for developers only:
** https://github.com/QubesOS/qubes-mgmt-salt-dom0-virtual-machines/blob/master/qvm/{{project_name_gateway_vm}}.sls
** https://github.com/QubesOS/qubes-mgmt-salt-dom0-virtual-machines/blob/master/qvm/{{project_name_workstation_vm}}.sls
In dom0
, run. [
No progress indicator is shown. Qubes feature request: [https://github.com/QubesOS/qubes-issues/issues/4215 add salt download progress indicator]
]
{{CodeSelect|code=
sudo qubesctl state.sls qvm.{{project_name_workstation_vm}}
}}
'''4.''' In case of issues.
Only in case of issues, refer to the footnotes for troubleshooting tips. [
If ]qubesctl
still does not work, try shutting down Qubes OS and rebooting the machine.
Please report if this step was necessary for you!
Otherwise, proceed.
'''5.''' Done.
Download and installation of {{q_project_name_short}} has been completed.
= Footnotes =
{{Footer}}