doc: prefix qubesctl with sudo

Fixes: #20
ben-grande · Feb 23, 2024 · 6ed3191 · 6ed3191
1 parent c5aaf1f
commit 6ed3191
Show file tree

Hide file tree

Showing 49 changed files with 361 additions and 361 deletions.
diff --git a/salt/ansible/README.md b/salt/ansible/README.md
@@ -16,18 +16,18 @@ Install Ansible and use it on the "ansible" app qube.
 
 - Top
 ```sh
-qubesctl top.enable ansible
-qubesctl --targets=tpl-ansible,ansible,ansible-minion state.apply
-qubesctl top.disable ansible
+sudo qubesctl top.enable ansible
+sudo qubesctl --targets=tpl-ansible,ansible,ansible-minion state.apply
+sudo qubesctl top.disable ansible
 ```
 
 - State
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply ansible.create
-qubesctl --skip-dom0 --targets=tpl-ansible state.apply ansible.install
-qubesctl --skip-dom0 --targets=ansible state.apply ansible.configure,zsh.touch-zshrc
-qubesctl --skip-dom0 --targets=ansible-minion state.apply ansible.configure-minion,zsh.touch-zshrc
+sudo qubesctl state.apply ansible.create
+sudo qubesctl --skip-dom0 --targets=tpl-ansible state.apply ansible.install
+sudo qubesctl --skip-dom0 --targets=ansible state.apply ansible.configure,zsh.touch-zshrc
+sudo qubesctl --skip-dom0 --targets=ansible-minion state.apply ansible.configure-minion,zsh.touch-zshrc
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/browser/README.md b/salt/browser/README.md
@@ -23,19 +23,19 @@ Firefox-ESR, W3M or Lynx.
 
 - Top
 ```sh
-qubesctl top.enable browser
-qubesctl --targets=tpl-browser,dvm-browser state.apply
-qubesctl top.disable browser
-qubesctl state.apply browser.appmenus
+sudo qubesctl top.enable browser
+sudo qubesctl --targets=tpl-browser,dvm-browser state.apply
+sudo qubesctl top.disable browser
+sudo qubesctl state.apply browser.appmenus
 ```
 
 - State
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply browser.create
-qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install
-qubesctl --skip-dom0 --targets=dvm-browser state.apply browser.configure
-qubesctl state.apply browser.appmenus
+sudo qubesctl state.apply browser.create
+sudo qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install
+sudo qubesctl --skip-dom0 --targets=dvm-browser state.apply browser.configure
+sudo qubesctl state.apply browser.appmenus
 ```
 <!-- pkg:end:post-install -->
 
@@ -46,28 +46,28 @@ to install:
 
 - Chromium:
 ```sh
-qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-chromium
+sudo qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-chromium
 ```
 - Chrome:
 ```sh
-qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-chrome
+sudo qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-chrome
 ```
 - Firefox-ESR:
 ```sh
-qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-firefox
+sudo qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-firefox
 ```
 - W3M:
 ```sh
-qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-w3m
+sudo qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-w3m
 ```
 - Lynx:
 ```sh
-qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-lynx
+sudo qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install-lynx
 ```
 
 Do not forget to sync the `appmenus`:
 ```sh
-qubesctl state.apply browser.appmenus
+sudo qubesctl state.apply browser.appmenus
 ```
 
 ## Usage

diff --git a/salt/debian-minimal/README.md b/salt/debian-minimal/README.md
@@ -17,16 +17,16 @@ it.
 
 - Top:
 ```sh
-qubesctl top.enable debian-minimal
-qubesctl --targets=debian-12-minimal state.apply
-qubesctl top.disable debian-minimal
+sudo qubesctl top.enable debian-minimal
+sudo qubesctl --targets=debian-12-minimal state.apply
+sudo qubesctl top.disable debian-minimal
 ```
 
 - State:
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply debian-minimal.create
-qubesctl --skip-dom0 --targets=debian-12-minimal state.apply debian-minimal.install
+sudo qubesctl state.apply debian-minimal.create
+sudo qubesctl --skip-dom0 --targets=debian-12-minimal state.apply debian-minimal.install
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/debian-xfce/README.md b/salt/debian-xfce/README.md
@@ -16,16 +16,16 @@ Creates the Debian Xfce Template as well as a Disposable Template based on it.
 
 - Top:
 ```sh
-qubesctl top.enable debian-xfce
-qubesctl --targets=debian-12-xfce state.apply
-qubesctl top.disable debian-xfce
+sudo qubesctl top.enable debian-xfce
+sudo qubesctl --targets=debian-12-xfce state.apply
+sudo qubesctl top.disable debian-xfce
 ```
 
 - State:
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply debian-xfce.create
-qubesctl --skip-dom0 --targets=debian-12-xfce state.apply debian-xfce.install
+sudo qubesctl state.apply debian-xfce.create
+sudo qubesctl --skip-dom0 --targets=debian-12-xfce state.apply debian-xfce.install
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/debian/README.md b/salt/debian/README.md
@@ -16,16 +16,16 @@ Creates the Debian template as well as a Disposable Template based on it.
 
 - Top:
 ```sh
-qubesctl top.enable debian
-qubesctl --targets=debian-12 state.apply
-qubesctl top.disable debian
+sudo qubesctl top.enable debian
+sudo qubesctl --targets=debian-12 state.apply
+sudo qubesctl top.disable debian
 ```
 
 - State:
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply debian.create
-qubesctl --skip-dom0 --targets=debian-12 state.apply debian.install
+sudo qubesctl state.apply debian.create
+sudo qubesctl --skip-dom0 --targets=debian-12 state.apply debian.install
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/dev/README.md b/salt/dev/README.md
@@ -18,18 +18,18 @@ sys-ssh-agent.
 
 - Top
 ```sh
-qubesctl top.enable dev
-qubesctl --targets=tpl-dev,dvm-dev,dev state.apply
-qubesctl top.disable dev
+sudo qubesctl top.enable dev
+sudo qubesctl --targets=tpl-dev,dvm-dev,dev state.apply
+sudo qubesctl top.disable dev
 ```
 
 - State
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply dev.create
-qubesctl --skip-dom0 --targets=tpl-dev state.apply dev.install
-qubesctl --skip-dom0 --targets=dvm-dev state.apply dev.configure-dvm
-qubesctl --skip-dom0 --targets=dev state.apply dev.configure
+sudo qubesctl state.apply dev.create
+sudo qubesctl --skip-dom0 --targets=tpl-dev state.apply dev.install
+sudo qubesctl --skip-dom0 --targets=dvm-dev state.apply dev.configure-dvm
+sudo qubesctl --skip-dom0 --targets=dev state.apply dev.configure
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/docker/README.md b/salt/docker/README.md
@@ -16,16 +16,16 @@ Setup docker in Qubes OS with the Docker repository.
 
 - Top
 ```sh
-qubesctl top.enable docker
-qubesctl --targets=tpl-qubes-builder,qubes-builder state.apply
-qubesctl top.disable docker
+sudo qubesctl top.enable docker
+sudo qubesctl --targets=tpl-qubes-builder,qubes-builder state.apply
+sudo qubesctl top.disable docker
 ```
 
 - State
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl --skip-dom0 --targets=tpl-qubes-builder state.apply docker.install
-qubesctl --skip-dom0 --targets=qubes-builder state.apply docker.configure
+sudo qubesctl --skip-dom0 --targets=tpl-qubes-builder state.apply docker.install
+sudo qubesctl --skip-dom0 --targets=qubes-builder state.apply docker.configure
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/dom0/README.md b/salt/dom0/README.md
@@ -17,21 +17,21 @@ etc.
 
 - Top
 ```sh
-qubesctl top.enable dom0
-qubesctl state.apply
-qubesctl top.disable dom0
+sudo qubesctl top.enable dom0
+sudo qubesctl state.apply
+sudo qubesctl top.disable dom0
 ```
 
 - State
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply dom0
+sudo qubesctl state.apply dom0
 ```
 <!-- pkg:end:post-install -->
 
 If you need to develop in Dom0, install some goodies (bare bones):
 ```sh
-qubesctl state.apply dom0.install-dev
+sudo qubesctl state.apply dom0.install-dev
 ```
 
 ## Usage

diff --git a/salt/dotfiles b/salt/dotfiles
diff --git a/salt/electrum/README.md b/salt/electrum/README.md
@@ -33,22 +33,22 @@ usage from ever connecting to the internet.
 
 - Top
 ```sh
-qubesctl top.enable electrum
-qubesctl --targets=tpl-electrum-builder,tpl-electrum,disp-electrum-builder,electrum,electrum-hot state.apply
-qubesctl top.disable electrum
-qubesctl state.apply electrum.appmenus
+sudo qubesctl top.enable electrum
+sudo qubesctl --targets=tpl-electrum-builder,tpl-electrum,disp-electrum-builder,electrum,electrum-hot state.apply
+sudo qubesctl top.disable electrum
+sudo qubesctl state.apply electrum.appmenus
 ```
 
 - State
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply electrum.create
-qubesctl --skip-dom0 --targets=tpl-electrum-builder state.apply electrum.install-builder
-qubesctl --skip-dom0 --targets=tpl-electrum state.apply electrum.install
-qubesctl --skip-dom0 --targets=disp-electrum-builder state.apply electrum.configure-builder
-qubesctl --skip-dom0 --targets=electrum state.apply electrum.configure
-qubesctl --skip-dom0 --targets=electrum-hot state.apply electrum.configure-hot
-qubesctl state.apply electrum.appmenus
+sudo qubesctl state.apply electrum.create
+sudo qubesctl --skip-dom0 --targets=tpl-electrum-builder state.apply electrum.install-builder
+sudo qubesctl --skip-dom0 --targets=tpl-electrum state.apply electrum.install
+sudo qubesctl --skip-dom0 --targets=disp-electrum-builder state.apply electrum.configure-builder
+sudo qubesctl --skip-dom0 --targets=electrum state.apply electrum.configure
+sudo qubesctl --skip-dom0 --targets=electrum-hot state.apply electrum.configure-hot
+sudo qubesctl state.apply electrum.appmenus
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/fedora-minimal/README.md b/salt/fedora-minimal/README.md
@@ -18,16 +18,16 @@ it.
 
 - Top:
 ```sh
-qubesctl top.enable fedora-minimal
-qubesctl --targets=fedora-39-minimal state.apply
-qubesctl top.disable fedora-minimal
+sudo qubesctl top.enable fedora-minimal
+sudo qubesctl --targets=fedora-39-minimal state.apply
+sudo qubesctl top.disable fedora-minimal
 ```
 
 - State:
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply fedora-minimal.create
-qubesctl --skip-dom0 --targets=fedora-39-minimal state.apply fedora-minimal.install
+sudo qubesctl state.apply fedora-minimal.create
+sudo qubesctl --skip-dom0 --targets=fedora-39-minimal state.apply fedora-minimal.install
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/fedora-xfce/README.md b/salt/fedora-xfce/README.md
@@ -16,16 +16,16 @@ Creates the Fedora Xfce template as well as a Disposable Template based on it.
 
 - Top:
 ```sh
-qubesctl top.enable fedora-xfce
-qubesctl --targets=fedora-39-xfce state.apply
-qubesctl top.disable fedora-xfce
+sudo qubesctl top.enable fedora-xfce
+sudo qubesctl --targets=fedora-39-xfce state.apply
+sudo qubesctl top.disable fedora-xfce
 ```
 
 - State:
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply fedora-xfce.create
-qubesctl --skip-dom0 --targets=fedora-39-xfce state.apply fedora-xfce.install
+sudo qubesctl state.apply fedora-xfce.create
+sudo qubesctl --skip-dom0 --targets=fedora-39-xfce state.apply fedora-xfce.install
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/fedora/README.md b/salt/fedora/README.md
@@ -16,16 +16,16 @@ Creates the Fedora template as well as a Disposable Template based on it.
 
 - Top:
 ```sh
-qubesctl top.enable fedora
-qubesctl --targets=fedora-39 state.apply
-qubesctl top.disable fedora
+sudo qubesctl top.enable fedora
+sudo qubesctl --targets=fedora-39 state.apply
+sudo qubesctl top.disable fedora
 ```
 
 - State:
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply fedora.create
-qubesctl --skip-dom0 --targets=fedora-39 state.apply fedora.install
+sudo qubesctl state.apply fedora.create
+sudo qubesctl --skip-dom0 --targets=fedora-39 state.apply fedora.install
 ```
 <!-- pkg:end:post-install -->
 

diff --git a/salt/fetcher/README.md b/salt/fetcher/README.md
@@ -23,17 +23,17 @@ Supported protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS,
 
 - Top:
 ```sh
-qubesctl top.enable fetcher
-qubesctl --targets=tpl-fetcher,dvm-fetcher state.apply
-qubesctl top.disable fetcher
+sudo qubesctl top.enable fetcher
+sudo qubesctl --targets=tpl-fetcher,dvm-fetcher state.apply
+sudo qubesctl top.disable fetcher
 ```
 
 - State:
 <!-- pkg:begin:post-install -->
 ```sh
-qubesctl state.apply fetcher.create
-qubesctl --skip-dom0 --targets=tpl-fetcher state.apply fetcher.install
-qubesctl --skip-dom0 --targets=dvm-fetcher state.apply fetcher.configure-dvm
+sudo qubesctl state.apply fetcher.create
+sudo qubesctl --skip-dom0 --targets=tpl-fetcher state.apply fetcher.install
+sudo qubesctl --skip-dom0 --targets=dvm-fetcher state.apply fetcher.configure-dvm
 ```
 <!-- pkg:end:post-install -->