diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c3b8225..89e3da9 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,8 +1,9 @@ +--- repos: - repo: local hooks: - id: salt-lint name: salt-lint - entry: salt-lint.sh + entry: scripts/salt-lint.sh language: script pass_filenames: false diff --git a/README.md b/README.md index b7dea0c..1cf6336 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ Qusal - Salt Formulas for Qubes OS R4.1. -Qusal' goal: +Qusal's goal: + - All global preferences customized to use qubes based on minimal templates; - All service templates with only the necessary programs installed; - Focus on tasks and usability @@ -38,29 +39,30 @@ updatevm : sys-pihole or sys-firewall or disp-sys-firewall ## Installation Clone this repository: -```sh +```shell git clone https://github.com/ben-grande/qusal.git ~/qusal git clone ssh://git@github.com/ben-grande/qusal.git ~/qusal ``` Copy this repository from some qube to Dom0 from Dom0: -```sh +```shell mkdir -p ~/QubesIncoming/QUBE qvm-run -p tar -cC qusal | tar -xvC ~/QubesIncoming/QUBE qusal ``` Example copying repository from the `dev` qube to Dom0 by running in Dom0: -```sh +```shell mkdir -p ~/QubesIncoming/dev -qvm-run -p tar -cC /home/user qusal | tar -xvC ~/QubesIncoming/QUBE qusal +qvm-run -p dev tar -cC /home/user qusal | tar -xvC ~/QubesIncoming/dev qusal ``` Copy the files to the Salt directories: -```sh +```shell cd qusal ./setup.sh ``` -The RPM packaging is not ready, help wanted for automatic generation. +Qusal is now installed. Please read the README.md of each project for further +information on how to install the desired package. ## Format @@ -83,13 +85,16 @@ The RPM packaging is not ready, help wanted for automatic generation. ### Qube naming 1. Qube name format: + - TemplateVM: `tpl-NAME` - StandaloneVM: `NAME` - AppVM: `NAME` - DispVM: `disp-NAME` - DispVM Template (AppVM): `dvm-NAME` - Service qubes (not a class): `sys-NAME` + 2. Label: + - Black (Ultimately trusted): You must trust Dom0, Templates, Vaults, Management qubes, these qubes control your system and hold valuable information. Examples: dom0, tpl-ssh, vault, default-mgmt-dvm. diff --git a/TODO.md b/TODO.md index 0870b47..d99ad7a 100644 --- a/TODO.md +++ b/TODO.md @@ -3,7 +3,6 @@ ## Priority - best-practices: use map.jinja to target different OSes - https://docs.saltproject.io/en/latest/topics/best_practices.html -- sys-ssh-agent: test - sys-pgp: split-gpg2 support: Working in R4.1? - sys-git: support Dom0 as a client, useful for fetching - sys-cacher: test