Exegol

https://docs.exegol.com
Admin
Exegol is a modular, community-driven cybersecurity environment designed for offensive security...
Tokens:33,827
Snippets:630
Trust Score:6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install xhost

Source: https://docs.exegol.com/install/on-void

Install xhost to enable graphical application support.

```bash
sudo xbps-install -S xhost
```

--------------------------------

### Install Git, Python, and Pip

Source: https://docs.exegol.com/install/on-gentoo

Install the necessary system packages for Exegol using emerge.

```bash
sudo emerge --ask dev-vcs/git
```

```bash
sudo emerge --ask dev-lang/python
```

```bash
sudo emerge --ask dev-python/pip
```

--------------------------------

### Install xhost

Source: https://docs.exegol.com/install/on-slackware

Install the xhost utility to manage X server access control.

```bash
slackpkg install xhost
```

--------------------------------

### Install Docker

Source: https://docs.exegol.com/install/on-opensuse

Installs the Docker engine on openSUSE.

```bash
sudo zypper install -y docker
```

--------------------------------

### Install Docker

Source: https://docs.exegol.com/first-install

Uses the official Docker installation script to set up the Docker engine.

```bash
curl -fsSL "https://get.docker.com/" | sh
```

--------------------------------

### Install Docker

Source: https://docs.exegol.com/install/on-manjaro

Install the Docker engine using pacman.

```bash
sudo pacman -Syu --noconfirm docker
```

--------------------------------

### Exegol Start Command Usage

Source: https://docs.exegol.com/wrapper/cli/start

Various configurations for starting Exegol containers, including interactive modes, custom workspaces, VPNs, and hardware device passthrough.

```bash
# Start interactively a container
exegol start

# Create a demo container using full image
exegol start demo full

# Spawn a shell from demo container
exegol start demo

# Create a container test with a custom shared workspace
exegol start test full -w "./project/pentest/"

# Create a container test sharing the current working directory
exegol start test full -cwd

# Create a container htb with a VPN
exegol start htb full --vpn "~/vpn/lab_Dramelac.ovpn"

# Create a container app with custom volume
exegol start app full -V "/var/app/:/app/"

# Get a shell based on tmux
exegol start --shell tmux

# Share a specific hardware device (like Proxmark)
exegol start -d "/dev/ttyACM0"

# Share every USB device connected to the host
exegol start -d "/dev/bus/usb/"
```

--------------------------------

### Install Exegol images via CLI

Source: https://docs.exegol.com/wrapper/cli/install

Commands to perform interactive installation or install a specific image variant.

```bash
# Install interactively an exegol image
exegol install

# Install or update the full image
exegol install full
```

--------------------------------

### Verifying my-resources setup

Source: https://docs.exegol.com/contribute/my-resources

Commands to inspect the container environment and logs to ensure the setup was applied correctly.

```bash
# Check that the setup was applied correctly
# Verify your feature directory exists and files are in place
ls -la /opt/my-resources/setup/YOUR_FEATURE/

# Check the setup logs for any errors or warnings
cat /var/log/exegol/load_setups.log

# If the file extension is .log.gz, use zcat
zcat /var/log/exegol/load_setups.log.gz

# Test that your feature works as expected
```

--------------------------------

### Install and Configure Docker

Source: https://docs.exegol.com/install/on-gentoo

Install Docker packages and verify kernel compatibility.

```bash
sudo emerge --ask --verbose app-containers/docker app-containers/docker-cli
```

```bash
/usr/share/docker/contrib/check-config.sh
```

--------------------------------

### Install system requirements

Source: https://docs.exegol.com/install/on-void

Install Git, Python3, and pipx using the xbps package manager.

```bash
sudo xbps-install -Syuy git python3 python3-pipx
```

--------------------------------

### Start and enable Docker

Source: https://docs.exegol.com/install/on-fedora

Starts the Docker service and configures it to launch automatically at boot.

```bash
# start docker
sudo systemctl start docker

# configure docker to start at boot
sudo systemctl enable --now docker
```

--------------------------------

### Configure pipx prerequisites

Source: https://docs.exegol.com/install/on-nixos

Install git, python3, and pipx along with Docker for the pipx installation method.

```nix
environment.systemPackages = with pkgs; [
  git
  python3
  pipx 
];
virtualisation.docker = {
  enable = true;
  # Do NOT enable rootless here — Exegol doesn’t support Docker rootless mode
  rootless.enable = false; # (false is the default)
};
```

--------------------------------

### Start Exegol Container

Source: https://docs.exegol.com/first-install

Launches an Exegol container instance.

```bash
exegol start
```

--------------------------------

### Install Docker

Source: https://docs.exegol.com/install/on-void

Install the Docker package on Void Linux.

```bash
sudo xbps-install -S docker
```

--------------------------------

### Configure Pipx and Install Exegol

Source: https://docs.exegol.com/install/on-gentoo

Ensure pipx is in the system path and install the Exegol wrapper.

```bash
pipx ensurepath && exec $SHELL
```

```bash
pipx install exegol
```

--------------------------------

### Start Exegol MCP server

Source: https://docs.exegol.com/mcp/getting-started

Manually launch the server to enable HTTP communication.

```bash
exegol-mcp
```

--------------------------------

### Start and enable Docker

Source: https://docs.exegol.com/install/on-arch

Starts the Docker service and configures it to launch automatically at system boot.

```bash
# start docker
sudo systemctl start docker 

# configure docker to start at boot
sudo systemctl enable --now docker
```

--------------------------------

### Install Exegol in a manual virtual environment

Source: https://docs.exegol.com/troubleshooting

Alternative method to install Exegol by manually creating and activating a Python virtual environment.

```bash
python3 -m venv path/to/venv
source path/to/venv/bin/activate
python3 -m pip install exegol
```

--------------------------------

### Install xorg-xhost

Source: https://docs.exegol.com/install/on-arch

Installs the xorg-xhost utility required for graphical application support.

```bash
sudo pacman -S xorg-xhost
```

--------------------------------

### Install Pipx in a Virtual Environment

Source: https://docs.exegol.com/install/on-gentoo

Set up a virtual environment and install pipx as required on Gentoo.

```bash
python3 -m venv ~/myenv
source ~/myenv/bin/activate
pip install pipx
```

--------------------------------

### Start an Exegol container with VPN configuration

Source: https://docs.exegol.com/faq

Use the built-in VPN option for a more secure and easier configuration.

```bash
exegol start <container_name> <image_name> --vpn <myconf.ovpn>
```

--------------------------------

### Install Firefox Extensions

Source: https://docs.exegol.com/images/my-resources

Add specific Firefox extensions by defining their GUID and installation URL within the ExtensionSettings object.

```json
"ExtensionSettings": {  
  "addon@darkreader.org": {  
    "installation_mode": "force_installed",
    "install_url": "https://addons.mozilla.org/firefox/downloads/latest/addon@darkreader.org/latest.xpi"
  },
}
```

--------------------------------

### Install Docker

Source: https://docs.exegol.com/install/on-arch

Installs the Docker engine on Arch Linux.

```bash
sudo pacman -Syu docker
```

--------------------------------

### Install Exegol MCP server

Source: https://docs.exegol.com/mcp/getting-started

Use pipx to install the Exegol MCP package.

```bash
pipx install exegol-mcp
```

--------------------------------

### Install Exegol Image

Source: https://docs.exegol.com/first-install

Downloads an Exegol container image to the local system.

```bash
exegol install
```

--------------------------------

### Start Docker with Systemd

Source: https://docs.exegol.com/install/on-gentoo

Commands to start and enable the Docker service using systemd.

```bash
# start docker
sudo systemctl start docker.service

# configure docker to start at boot
sudo systemctl enable docker.service
```

--------------------------------

### Install System Requirements

Source: https://docs.exegol.com/install/on-opensuse

Installs Git, Python3, and Pipx using the zypper package manager.

```bash
sudo zypper refresh && sudo zypper install -y git python3 python313-pipx
```

--------------------------------

### Build Exegol images via CLI

Source: https://docs.exegol.com/wrapper/cli/build

Examples of building images interactively, specifying names, profiles, and logging output.

```bash
# Build interactively an exegol image
exegol build

# Build interactively a local image named myimage
exegol build myimage

# Build the myimage image based on the full profile and log the operation
exegol build myimage full --build-log /tmp/build.log
```

--------------------------------

### Install Argcomplete

Source: https://docs.exegol.com/first-install

Installs the argcomplete package to enable command auto-completion.

```bash
pipx install argcomplete
```

--------------------------------

### Starting a test container

Source: https://docs.exegol.com/contribute/my-resources

Command to start a container with increased verbosity to verify my-resources application.

```bash
# Create and start a container for the tests (my-resources is enabled by default) and increase the verbosity level to print my-resources
exegol start -v "testcontainer" "testimage"
```

--------------------------------

### Start a privileged Exegol container

Source: https://docs.exegol.com/faq

Run a container with full permissions to allow manual VPN configuration.

```bash
exegol start <container_name> <image_name> --privileged
```

--------------------------------

### Install system requirements

Source: https://docs.exegol.com/install/on-fedora

Installs Git, Python3, and Pipx using the dnf package manager.

```bash
sudo dnf -y update && sudo dnf -y install git python3 pipx
```

--------------------------------

### Start TemplateVM

Source: https://docs.exegol.com/install/on-qubesos

Initializes the specified TemplateVM in the background.

```bash
qvm-start debian-13-exegol &
```

--------------------------------

### Manage Exegol Resources

Source: https://docs.exegol.com/install/on-qubesos

Commands for updating resources and starting containers.

```bash
exegol update
```

```bash
exegol start container1
```

--------------------------------

### Install Git and Python on Linux

Source: https://docs.exegol.com/first-install

Installs necessary dependencies for Exegol on Debian-based Linux distributions.

```bash
sudo apt update && sudo apt install -y git python3 pipx
```

--------------------------------

### View container summary output

Source: https://docs.exegol.com/wrapper/features

Example output showing container details including credentials and remote desktop access URL.

```text
⭐ Container summary                                        
┌──────────────────┬───────────────────────────────────────┐
│             Name │ gui                                   │
│            Image │ nightly - v.d34db33f (Up to date)     │
├──────────────────┼───────────────────────────────────────┤
│      Credentials │ root : iozLHIjJFxoOLTTaNymO50uKT2RlvI │
│   Remote Desktop │ http://localhost:58089                │
│      Console GUI │ On ✔ (X11)                            │
│          Network │ host                                  │
│         Timezone │ Off 🪓                                │
│ Exegol resources │ On ✔ (/opt/resources)                 │
│     My resources │ On ✔ (/opt/my-resources)              │
│    Shell logging │ Off 🪓                                │
│       Privileged │ Off ✔                                 │
│        Workspace │ Dedicated (/workspace)                │
└──────────────────┴───────────────────────────────────────┘
```

--------------------------------

### Install Exegol Wrapper

Source: https://docs.exegol.com/first-install

Installs the Exegol Python package in an isolated environment using pipx.

```bash
pipx install exegol
```

--------------------------------

### Install Docker via static binaries

Source: https://docs.exegol.com/install/on-slackware

Download, extract, and install official Docker static binaries to /usr/local/bin.

```bash
# Download the official Docker binary release
wget https://download.docker.com/linux/static/stable/x86_64/docker-28.3.2.tgz

# Extract it
tar -xvzf docker-28.3.2.tgz
cd docker

# Copy the binaries to the system path
cp dockerd docker containerd containerd-shim-runc-v2 docker-init docker-proxy runc ctr /usr/local/bin/

# Verify installation
which dockerd
dockerd --version

# Start the Docker daemon manually
dockerd &
```

--------------------------------

### Configure X11 for Graphical Apps

Source: https://docs.exegol.com/install/on-gentoo

Install xhost and configure display access for containers.

```bash
sudo emerge --ask x11-apps/xhost
```

```bash
xhost +local:
```

```bash
export DISPLAY=:0
```

--------------------------------

### Display version information

Source: https://docs.exegol.com/wrapper/cli/version

Use the version action to retrieve setup details or system information when running in debug mode.

```bash
# Show version information
exegol version

# Show version and system information
exegol version -vvv
```

--------------------------------

### Start Persistent Containers

Source: https://docs.exegol.com/install/on-qubesos

Initialize containers with desktop support for use within the AppVM.

```bash
exegol start container1 --desktop
exegol start container2 --desktop
exegol start container3 --desktop
```

--------------------------------

### Common activation and management commands

Source: https://docs.exegol.com/wrapper/cli/activate

Examples for interactive activation, unattended activation, and license revocation.

```bash
# Activate Exegol interactively
exegol activate

# Activate Exegol non-interactively
exegol activate --accept-eula --api "$API_KEY" --license-id "$LICENSE_ID"

# Revoke current license
exegol activate --revoke
```

--------------------------------

### Install system requirements

Source: https://docs.exegol.com/install/on-slackware

Update the package database and install essential dependencies including Python3, Git, and OpenSSL.

```bash
sudo slackpkg update
sudo slackpkg install python3 git
sudo slackpkg upgrade python3 git openssl
```

--------------------------------

### Install system requirements

Source: https://docs.exegol.com/install/on-arch

Installs Git, Python3, and Pipx using the Arch Linux package manager.

```bash
sudo pacman -Syu --noconfirm && sudo pacman -S --noconfirm git python-pipx
```

--------------------------------

### Define a tool installation function

Source: https://docs.exegol.com/contribute/images

Standard structure for creating a new tool installation function in the packages directory.

```bash
function install_yourtool() {
    colorecho "Installing yourtool"
    # tool install commands [...]
    add-aliases yourtool
    add-history yourtool
    add-test-command "yourtool.py --help"
    add-to-list "yourtool,https://link.to/the/tool,description"
}
```

--------------------------------

### Start Docker and Registry with OpenRC

Source: https://docs.exegol.com/install/on-gentoo

Commands to manage Docker and the registry service using OpenRC.

```bash
rc-update add docker default
rc-service docker start
```

```bash
rc-update add registry default
rc-service registry start
```

--------------------------------

### Start Metasploit Database

Source: https://docs.exegol.com/troubleshooting

Commands to initialize and verify the Metasploit database connection at runtime.

```bash
msfdb start
msfconsole -qx 'db_status; exit'
[*] Connected to msf. Connection type: postgresql.
```

--------------------------------

### Install tools via pipx

Source: https://docs.exegol.com/contribute/images

Commands for installing tools from GitHub or local sources, and injecting additional requirements into the tool's virtual environment.

```bash
pipx install --system-site-packages git+https://github.com/AUTHOR/REPO
```

```bash
git -C /opt/tools/ clone --depth 1 https://github.com/AUTHOR/REPO
pipx install --system-site-packages /opt/tools/yourtool/
```

```bash
pipx inject yourtool therequirement
```

--------------------------------

### OpenVPN Multi-file Directory Structure

Source: https://docs.exegol.com/wrapper/features

Example directory structure for an OpenVPN configuration using multiple files with relative paths.

```text
. my_vpn/
|- configuration.ovpn => This file contains the OpenVPN configuration with relative path to the various external files
|- root_ca.pem => Certificat Authority file referenced as `./root_ca.pem` in configuration.ovpn
|- my_user.crt => User's personal certificate file referenced as `./my_user.crt` in configuration.ovpn
|- my_user.key => User's personal key file referenced as `./my_user.key` in configuration.ovpn (password protected file are not supported for non-interactive logon)
```

--------------------------------

### Verify Docker installation

Source: https://docs.exegol.com/install/on-slackware

Check the Docker version and run the hello-world container to confirm functionality.

```bash
docker version
docker run hello-world
```

--------------------------------

### Update Exegol components

Source: https://docs.exegol.com/wrapper/cli/update

Common command-line examples for updating Exegol modules and images.

```bash
# Update interactively an exegol image:
exegol update

# Update the full image:
exegol update full

# Update the full image without updating exegol modules:
exegol update --skip-git full

# Update exegol modules and have the option to change branch without updating docker image:
exegol update -v --skip-images
```

--------------------------------

### Define tool aliases

Source: https://docs.exegol.com/contribute/images

Example content for an alias file located in /sources/assets/shells/aliases.d/.

```bash
alias tool.py='python3 /opt/tools/yourtool/tool.py'
```

--------------------------------

### Implement multi-architecture support

Source: https://docs.exegol.com/contribute/images

Conditional logic to detect the system architecture and execute appropriate installation commands for AMD64 or ARM64.

```bash
if [[ $(uname -m) = 'x86_64' ]]
then
    # command for AMD64
elif [[ $(uname -m) = 'aarch64' ]]
then
    # command for ARM64
else
    criticalecho-noexit "This installation function doesn't support architecture $(uname -m)" && return
fi
```

--------------------------------

### Manage Virtual Environment

Source: https://docs.exegol.com/contribute/install

Commands to create, activate, install dependencies, and deactivate the virtual environment.

```bash
# Create a virtual environment
python3 -m venv .venv

# Activate it
source .venv/bin/activate
```

```bash
# Install runtime dependencies
pip3 install -r requirements.txt
```

```bash
deactivate
```

--------------------------------

### Start AppVM Terminal

Source: https://docs.exegol.com/install/on-qubesos

Launch a terminal session within the newly created AppVM.

```bash
qvm-run -a exegol-appvm xfce4-terminal
```

--------------------------------

### Run info command with various options

Source: https://docs.exegol.com/wrapper/cli/info

Examples of using the info command to target specific containers or adjust verbosity levels.

```bash
# Print containers and images essentials information:
exegol info

# Print the detailed configuration of the "demo" container:
exegol info demo

# Print verbose information:
exegol info -v

# Print advanced information:
exegol info -vv

# Print debug information:
exegol info -vvv
```

--------------------------------

### Install pipx

Source: https://docs.exegol.com/install/on-slackware

Ensure pip is upgraded and install pipx for managing isolated Python applications.

```bash
python3 -m ensurepip --upgrade
python3 -m pip install --user pipx
```

--------------------------------

### Enable Docker at boot

Source: https://docs.exegol.com/install/on-slackware

Append the Docker daemon startup command to /etc/rc.d/rc.local.

```bash
echo '
# Start Docker daemon at boot
if [ -x /usr/local/bin/dockerd ]; then
  /usr/local/bin/dockerd &
fi
' >> /etc/rc.d/rc.local
```

--------------------------------

### Create AppVM

Source: https://docs.exegol.com/install/on-qubesos

Create a new AppVM based on the Exegol template.

```bash
qvm-create --class AppVM --template debian-13-exegol --label red exegol-appvm
```

--------------------------------

### Run and Configure Exegol Development Version

Source: https://docs.exegol.com/contribute/install

Commands to execute the development version and configure system-wide access.

```bash
# On Linux
sudo /path/to/Exegol/venv/bin/python3 /path/to/Exegol/exegol.py

# On macOS, Windows
/path/to/Exegol/venv/bin/python3 /path/to/Exegol/exegol.py
```

```bash
# Create a symbolic link, from the Exegol directory
sudo ln -s "$(pwd)/exegol.py" "/usr/local/bin/exegol-dev"
```

```bash
# For bash
echo "alias exegol-dev='sudo -E $(which exegol-dev)'" >> ~/.bash_aliases
source ~/.bashrc
```

```bash
# Regular install
exegol version

# Source install
exegol-dev version
```

--------------------------------

### Configure Exegol and Docker

Source: https://docs.exegol.com/install/on-nixos

Add the Exegol package and enable the Docker engine in your NixOS configuration.

```nix
environment.systemPackages = with pkgs; [
  exegol
];
virtualisation.docker = {
  enable = true;
  # Do NOT enable rootless here — Exegol doesn’t support Docker rootless mode
  rootless.enable = false; # (false is the default)
};
```

--------------------------------

### Define tool command history

Source: https://docs.exegol.com/contribute/images

Example content for a history file located in /sources/assets/shells/history.d/.

```bash
yourtool.py --user "$USER" --password "$PASSWORD" --target "$TARGET"
yourtool.py --mode enum --user "$USER" --target "$TARGET"
yourtool.py --mode unauthenticated
```

--------------------------------

### List all aliases

Source: https://docs.exegol.com/tips-and-tricks

Displays all currently configured aliases in the Exegol image.

```bash
alias
```

--------------------------------

### Diagnose CRLF errors

Source: https://docs.exegol.com/troubleshooting

Example of error output when line endings are incorrectly formatted on Windows.

```bash
/.exegol/entrypoint.sh: line 3: trap: SIGTERM : invalid signal specification
/.exegol/entrypoint.sh: line 4: $'\r': command not found
/.exegol/entrypoint.sh: line 5: syntax error near unexpected token $'{\r''
/.exegol/entrypoint.sh: line 5: function exegol_init() {
```

--------------------------------

### Update Exegol via Pip

Source: https://docs.exegol.com/wrapper/cli/update

Command to update the Exegol wrapper package when installed via Pip.

```bash
python3 -m pip install --upgrade exegol
```

--------------------------------

### Exegol exec command examples

Source: https://docs.exegol.com/wrapper/cli/exec

Various ways to execute commands in Exegol containers, including temporary containers, background execution, and privilege management.

```bash
# Execute the command bloodhound in the container demo:
exegol exec demo bloodhound

# Execute the command 'nmap -h' with console output in the container demo:
exegol exec -v demo 'nmap -h'

# Execute the command bloodhound in background within the demo container:
exegol exec -b demo bloodhound

# Execute the command bloodhound with neo4j in a temporary container based on the full image:
exegol exec --tmp full 'neo4j start && 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

# Execute the command wireshark with network admin privileges:
exegol exec -b --tmp --cap NET_ADMIN full wireshark
```

--------------------------------

### Disk Space Error Message

Source: https://docs.exegol.com/contribute/maintainers-notes

Example of the error message displayed when the CI/CD runner runs out of disk space.

```text
You are running out of disk space. The runner will stop working when the machine runs out of disk space. Free space left: 62 MB
```

--------------------------------

### Feature deployment structure in Bash

Source: https://docs.exegol.com/contribute/my-resources

Standard function structure for deploying features, including directory checks and setup creation.

```bash
function deploy_your_feature() {
    wrapper_verbose "Deploying your feature"
    
    # Check if feature directory exists
    if [[ -d "$MY_SETUP_PATH/your_feature" ]]; then
        # Handle existing setup
        logger_verbose "Processing existing setup"
        # Your code here
    else
        # Create new setup
        logger_verbose "Creating new setup"
        mkdir -p "$MY_SETUP_PATH/your_feature"
        # Your code here
    fi
}
```

--------------------------------

### Building a local Exegol image

Source: https://docs.exegol.com/contribute/my-resources

Command to build a local image for testing changes.

```bash
# Build the local image with your changes
exegol build "testimage" "full" --build-log "/tmp/exegol_testimage.log"
```
Tokens:
Raw