doc: update README.md

This commit is contained in:
Ben Grande 2024-01-04 22:05:35 +01:00
parent 0216297ee6
commit 41b71eed46

View File

@ -7,10 +7,8 @@ Salt Formulas for Qubes OS.
**Warning**: Not ready for production, development only. Breaking changes can **Warning**: Not ready for production, development only. Breaking changes can
and will be introduced in the meantime. You've been warned. and will be introduced in the meantime. You've been warned.
The following projects are incomplete (not a complete list): The following projects are unfinished (not a complete list):
- sys-net: can't be provisioned automatically due to the minimal template
- sys-firewall: can't be provisioned automatically due to the minimal template
- sys-wireguard: unfinished firewall port to nft, waiting for R4.2 - sys-wireguard: unfinished firewall port to nft, waiting for R4.2
- sys-syncthing: broken firewall script functionality with disposable netvm - sys-syncthing: broken firewall script functionality with disposable netvm
@ -64,9 +62,9 @@ Qubes global settings (qubes-prefs) that will be managed:
- **default_netvm**: sys-pihole, sys-firewall or disp-sys-firewall - **default_netvm**: sys-pihole, sys-firewall or disp-sys-firewall
- **management_dispvm**: dvm-mgmt - **management_dispvm**: dvm-mgmt
- **updatevm**: sys-pihole, sys-firewall or disp-sys-firewall - **updatevm**: sys-pihole, sys-firewall or disp-sys-firewall
- **default_audiovm**: sys-audio
To be implemented: To be implemented:
- **default_audiovm**: sys-audio
- **default_guivm**: sys-gui - **default_guivm**: sys-gui
## Prerequisites ## Prerequisites
@ -134,6 +132,9 @@ valuable qube that can hold secrets or pristine data. A compromise of the
client qube can extend to the server, therefore configure the installation client qube can extend to the server, therefore configure the installation
according to your threat model. according to your threat model.
If you are unsure how to start, follow the [bootstrap guide](BOOTSTRAP.md) for
some ideas on how to customize your system.
## Contribute ## Contribute
There are several ways to contribute to this project. Spread the word, help on There are several ways to contribute to this project. Spread the word, help on