Merge pull request #180 from 100111001/main

Improved readme and saltstack script by adding more detailed installation instructions and removing hard coded templates

README.md

@@ -86,7 +86,7 @@ qvm-features mirage-firewall no-default-kernelopts 1
 ```
 
 ### Deployment using saltstack
-If you're familiar how to run salt states in Qubes, you can also use the script `SaltScriptToDownloadAndInstallMirageFirewallInQubes.sls` to automatically deploy the latest version of mirage firewall in your Qubes OS. The script checks the checksum from the integration server and compares with the latest version provided in the github releases. It might be necessary to adjust the VM templates in the script which are used for downloading of the mirage unikernel. Also don't forget to change the VMs in which the uni kernel should be used or adjust the "Qubes Global Settings".
+If you're familiar how to run salt states in Qubes, you can also use the script `SaltScriptToDownloadAndInstallMirageFirewallInQubes.sls` to automatically deploy the latest version of mirage firewall in your Qubes OS. An introduction can be found [here](https://forum.qubes-os.org/t/qubes-salt-beginners-guide/20126) and [here](https://www.qubes-os.org/doc/salt/). Following the instructions from the former link, you can run the script in dom0 with the command `sudo qubesctl --show-output state.apply SaltScriptToDownloadAndInstallMirageFirewallInQubes saltenv=user`. The script checks the checksum from the integration server and compares with the latest version provided in the github releases. It might be necessary to adjust the VM templates in the script which are used for downloading of the mirage unikernel, if your default templates do not have the tools `curl` and `tar` installed by default. Also don't forget to change the VMs in which the uni kernel should be used or adjust the "Qubes Global Settings".
 
 ## Upgrading
 

SaltScriptToDownloadAndInstallMirageFirewallInQubes.sls

@@ -3,9 +3,9 @@
 # After the install, you have to switch your AppVMs to use the mirage firewall vm created by this script e.g. by using "Qubes Global Settings"
 # inspired by: https://github.com/one7two99/my-qubes/tree/master/mirage-firewall
 
-# You might want to adjust the following 2 variables to use up-to-date templates on your qubes
-{% set DownloadVMTemplate = "fedora-38" %}
-{% set DispVM = "fedora-38-dvm" %}
+# default template + dispvm template are used. Possible optimization is to use min-dvms
+{% set DownloadVMTemplate = salt['cmd.shell']("qubes-prefs default_template") %}
+{% set DispVM = salt['cmd.shell']("qubes-prefs default_dispvm") %}
 
 {% set DownloadVM = "DownloadVmMirage" %}
 {% set MirageFW = "sys-mirage-fw" %}
@@ -33,7 +33,7 @@ create-downloader-VM:
 download-and-unpack-in-DownloadVM4mirage:
   cmd.run: 
     - names:
-      - qvm-run --pass-io {{ DownloadVM }} {{ "wget " ~ DownloadBinary }}
+      - qvm-run --pass-io {{ DownloadVM }} {{ "curl -L -O " ~ DownloadBinary }}
       - qvm-run --pass-io {{ DownloadVM }} {{ "tar -xvjf " ~ Filename }}
     - require: 
       - create-downloader-VM