Merge pull request #113 from ThePorgs/dev

Fixing tool name and examples, format error and contribution docs

Author: ShutdownRepo

docs/src/contribute/images.md

@@ -177,11 +177,17 @@ function install_yourtool() {
 == Download release
 ```bash
 function install_yourtool() {
+    # CODE-CHECK-WHITELIST=add-aliases
     colorecho "Installing yourtool"
     local URL
-    URL=$(curl --location --silent "https://api.github.com/repos/AUTHOR/REPO/releases/latest" | grep 'browser_download_url' | grep -o 'https://[^"]*' | grep 'linux' | grep "$arch")
+    curl --location --silent --output /tmp/meta.json "https://api.github.com/repos/AUTHOR/REPO/releases/latest"
+    URL=$(cat /tmp/meta.json | grep 'browser_download_url' | grep -o 'https://[^"]*' | grep 'linux' | grep "$arch")
+    if [[ -z "$URL" ]]; then
+        cat /tmp/meta.json
+    fi
+    rm /tmp/meta.json
     curl --location -o /tmp/yourtool.tar.xz "$URL"
-    tar -xf /tmp/yourtool.tar.xz --directory /tmp
+    tar -xzf /tmp/yourtool.tar.xz --directory /tmp
     rm /tmp/yourtool.tar.xz
     mv /tmp/yourtool/yourtool /opt/tools/bin/yourtool
     add-history yourtool
@@ -190,9 +196,29 @@ function install_yourtool() {
 }
 ```
 
-> [!NOTE]
-> Install tools in `/opt/tools/` or place binaries in `/opt/tools/bin/`.
+== Via install script
+
+Installing tools via external install scripts is to be avoided for the following reasons:
+
+- **Trust and security:** running code from the Internet, which could be modified at any time without your knowledge.
+- **Lack of transparency:** can't easily audit what the script will do in advance.
+- **Reproducibility:** scripts may change or disappear, breaking reproducibility.
+- **Silent failures:** install scripts may change system settings, fail quietly, or have unexpected side effects not tracked by package managers.
+
+Prefer using distribution packages, versioned binaries, or building from source for safer and more maintainable installs.
 
+```bash
+function install_yourtool() {
+    colorecho "Installing yourtool"
+    curl --location --silent --output /tmp/install_thetool.json "https://sometool.com/install"
+    bash /tmp/install_thetool.json
+    rm /tmp/install_thetool.json
+    add-history yourtool
+    add-history yourtool
+    add-test-command "yourtool --help"
+    add-to-list "yourtool,https://github.com/AUTHOR/REPO,description"
+}
+```
 :::
 
 ### Temporary fixes (tempfix)

docs/src/images/my-resources.md

@@ -267,7 +267,7 @@ or you can add a new folder:
 
 > [!WARNING]
 > This covers the previous method for personalizing Firefox; the current
-> approach utilizes `` policy <`firefox `` (policy)\>\`.
+> approach uses [firefox policy](#firefox-policy).
 
 > [!INFO]
 > Available from version `3.0.2` to `3.1.5` of any exegol image.

docs/src/tips-and-tricks.md

@@ -74,7 +74,7 @@ commands in the history, without changing the values every time.
 - `shellerator` can be used to generate a reverse-shell command dynamically.
 - On the attacker's side, a reverse shell obtained through a `netcat` tunnel can be improved (see [ropnop.com](https://blog.ropnop.com/upgrading-simple-shells-to-fully-interactive-ttys/) or [0xffsec.com](https://0xffsec.com/handbook/shells/full-tty/)).
 - A simple alternative to upgrading a netcat reverse shell is to use `rlwrap <netcat listener command>`.
-- Instead of using `netcat` and "upgrading" the shell manually, `pwncat-cs` ([calebstewart/pwncat](https://github.com/calebstewart/pwncat)) can be used to obtain an even better reverse-shell experience, especially with UNIX-like targets.
+- Instead of using `netcat` and "upgrading" the shell manually, `pwncat-vl` ([Chocapikk/pwncat-vl](https://github.com/Chocapikk/pwncat-vl)) can be used to obtain an even better reverse-shell experience, especially with UNIX-like targets.
 
 ## Keyboard shortcuts
 

docs/src/wrapper/cli/exec.md

@@ -50,18 +50,18 @@ exegol exec demo bloodhound
 # Execute the command 'nmap -h' with console output in the container demo:
 exegol exec -v demo 'nmap -h'
 
-# Execute a command in background within the demo container:
+# Execute the command bloodhound in background within the demo container:
 exegol exec -b demo bloodhound
 
-# Execute the command bloodhound in a temporary container based on the full image:
-exegol exec --tmp full bloodhound
+# Execute the command bloodhound with neo4j in a temporary container based on the full image:
+exegol exec --tmp full 'neo4j start && bloodhound'
 
-# Execute a command in background with a temporary container:
-exegol exec -b --tmp full bloodhound
+# Execute the command bloodhound with neo4j in background with a temporary container:
+exegol exec -b --tmp full 'neo4j start && bloodhound'
 
 # Execute Wireshark in background, in a privileged temporary container:
-exegol exec --background --tmp --privileged "nightly" "wireshark"
+exegol exec --background --tmp --privileged nightly wireshark
 
-# Execute the command wireshark with network admin privileged:
+# Execute the command wireshark with network admin privileges:
 exegol exec -b --tmp --cap NET_ADMIN full wireshark
 ```