Files
conquest/docs/1-INSTALLATION.md
2025-10-31 10:14:35 +01:00

1.9 KiB

Installation

  1. Clone the Conquest repository
git clone https://github.com/jakobfriedl/conquest
cd conquest
  1. Install Nim.
curl https://nim-lang.org/choosenim/init.sh -sSf | sh

After it is installed, the Nim binaries need to be added to the PATH.

export PATH=/home/kali/.nimble/bin:$PATH
  1. Install dependencies

The operator client requires the following dependencies to be installed on Ubuntu/Debian systems.

sudo apt update
sudo apt install gcc g++ make git curl xz-utils
sudo apt install libglfw3-dev libgl1-mesa-dev libglu1-mesa-dev libx11-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev
  1. The Conquest binaries for team server and client are designed to be compiled on a UNIX system using the nimble command. This command installs and updates all dependencies and third-party libraries automatically.
nimble server
nimble client

Optionally, the required dependencies can be installed manually using the following command.

nimble install -d
  1. Start the Conquest team server with a C2 profile. The default profile is located in data/profile.toml and can be adapted by the operator.
sudo bin/server -p data/profile

On the first start, the Conquest team server creates the Conquest database in the data directory, as well as the team server's private key in data/keys, which is used for the key exchange between team server, client and agent.

Team server start

  1. Start the Conquest operator client
bin/client

By default, the Conquest client connects to localhost:37573 to connect to the team server. The address and port can be specified from the command-line using the -i and -p flags, in order to connect to a remote team server. The team server port is specified in the malleable C2 profile.

bin/client -i <team-server-address> -p <team-server-port>