admin/conquest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jakob Friedl
2025-10-31 18:00:57 +01:00
parent 3459c279af
commit 8e16843aec
2 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/1-INSTALLATION.md
View File

@@ -12,10 +12,10 @@ cd conquest
curl https://nim-lang.org/choosenim/init.sh -sSf | sh
```
After it is installed, the Nim binaries need to be added to the PATH.
After it is installed, the Nim binaries need to be added to the PATH. This is done by adding the following line to the `.bashrc`/`.zshrc`/`.profile` configuration.
```
export PATH=/home/kali/.nimble/bin:$PATH
export PATH=/home/<user>/.nimble/bin:$PATH
```
## 3. Install dependencies
@@ -28,6 +28,12 @@ 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 libgtk2.0-0
```
In some cases, the agent build process fails due to insufficient permissions. Execute the following command to make the build script executable.
```
chmod +x src/agent/build.sh
```
## 4. Compile Conquest binaries
The Conquest binaries are compiled using the `nimble` command, which installs and updates all Nim libraries and dependencies automatically.
@@ -47,7 +53,7 @@ nimble install -d
The default profile is located in [data/profile.toml](../data/profile.toml) and can be adapted by the operator.
```
sudo bin/server -p data/profile
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.