worker.md

export CRYTON_WORKER_NAME=name
Use `unset` to remove a variable.
Some settings can be overridden using the CLI. Try using:
```
cryton-worker start --help
```
<div id="settings-permanent"></div>

First, make sure the app directory exists:
```shell
mkdir -p ~/.local/cryton-worker/
```

Download the default settings into the app directory:

=== "curl"

    ```shell
    curl -o ~/.local/cryton-worker/.env https://gitlab.ics.muni.cz/cryton/cryton-worker/-/raw/{{{ git_release }}}/.env
    ```

=== "wget"

    ```shell
    wget -O ~/.local/cryton-worker/.env https://gitlab.ics.muni.cz/cryton/cryton-worker/-/raw/{{{ git_release }}}/.env
    ```

Open the file and update it to your needs.
<div id="settings-docker"></div>

To override a variable use the `-e` or the `--env-file` option:
```
docker run -e CRYTON_WORKER_NAME=name --env-file relative/path/to/.env ...
```

More information can be found [here](https://docs.docker.com/engine/reference/commandline/run/#env){target="_blank"}.
<div id="settings-compose"></div>

Override variables in the `environment` or the `env_file` attribute:
```
services
  service:
    environment:
      - CRYTON_WORKER_NAME=name
    env_file:
      - relative/path/to/.env
```

More information can be found [here](https://docs.docker.com/compose/environment-variables/set-environment-variables/#use-the-environment-attribute){target="_blank"}.
Worker's name is used as an identifier. Make sure it matches once you use it in Cryton Core.
The default value in Docker is set to `/app`.
!!! danger "Requirements"

    - [Docker Compose](https://docs.docker.com/compose/install/){target="_blank"}
    - Create [permanent settings](#settings-permanent)

!!! tip "Recommendations"

    - Docker [Post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/){target="_blank"}

Switch to the app directory:
```shell
cd ~/.local/cryton-worker/
```

Download the Compose configuration:

=== "curl"

    ```shell
    curl -O https://gitlab.ics.muni.cz/cryton/cryton-worker/-/raw/{{{ git_release }}}/docker-compose.prerequisites.yml
    ```

=== "wget"

    ```shell
    wget https://gitlab.ics.muni.cz/cryton/cryton-worker/-/raw/{{{ git_release }}}/docker-compose.prerequisites.yml
    ```

Run the Compose configuration:
```
docker compose -f docker-compose.prerequisites.yml up -d
```
In case you have a running Postgres instance, you can reuse it. Just make sure it's accessible from the *msfconsole* and update the `CRYTON_WORKER_MSF_DB_*` variables to your needs.
You also have to **update the Compose configuration** you're using, so it won't launch a new database instance.

More information about the MSF Docker image can be found [here](../docker-settings.md#metasploit-framework).
- [Docker Compose](https://docs.docker.com/compose/install/){target="_blank"}
- Create [permanent settings](#settings-permanent)
- Docker [post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/){target="_blank"}
- Override the [settings](#settings)
cd ~/.local/cryton-worker/
Make sure that the `CRYTON_WORKER_MODULES_DIRECTORY` setting contains the default value.
```shell
curl -O https://gitlab.ics.muni.cz/cryton/cryton-worker/-/raw/{{{ git_release }}}/docker-compose.yml
```
```shell
wget https://gitlab.ics.muni.cz/cryton/cryton-worker/-/raw/{{{ git_release }}}/docker-compose.yml
```
docker compose up -d
```
[+] Running 6/6
 ✔ Network cryton-worker_default              Created      0.1s
 ✔ Volume "cryton-worker_cryton_msf_db_data"  Created      0.0s
 ✔ Container cryton-empire                    Started      0.0s
 ✔ Container cryton-msf-db                    Healthy      0.0s
 ✔ Container cryton-msf                       Started      0.0s
 ✔ Container cryton-worker                    Started      0.0s
```
docker compose cryton_worker logs
- [Python](https://www.python.org/about/gettingstarted/){target="_blank"} >={{{ python.min }}},<{{{ python.max }}}
- [pipx](https://pypa.github.io/pipx/){target="_blank"}
- Override the [settings](#settings)
- Enable [shell completion](#shell-completion)
Make sure that the `CRYTON_WORKER_MODULES_DIRECTORY` setting contains the default value.
```shell
pipx install cryton-worker=={{{ release_version }}}.*
```
```shell
pip install --user cryton-worker=={{{ release_version }}}.*
```
- [Docker](https://docs.docker.com/engine/install/){target="_blank"}
- Docker [Post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/){target="_blank"}
- Override the [settings](#settings)
- If you're using persistent settings, switch to the [app directory](#cryton_worker_app_directory) and [pass the settings](#settings-docker)
Install the [modules](modules.md#installation) into the app directory and export the path:
```shell
export CRYTON_WORKER_MODULES_DIRECTORY=~/.local/cryton-worker/modules/
```

!!! warning "Make sure that the persistent settings match"

    Check the real value of the variable using:
    ```shell
    export | grep CRYTON_WORKER_MODULES_DIRECTORY
    ```

The following command ensures effortless deployment. It mounts the modules and shares the host's networking namespace.
```
docker run --network host -v ${CRYTON_WORKER_MODULES_DIRECTORY}:/app/modules -d registry.gitlab.ics.muni.cz:443/cryton/cryton-worker:{{{ release_version }}}
```

!!! warning "Limitations"

    - The easiest way to make the container accessible from the outside and to allow the container to access the prerequisites is to use the `--network host` option
    - Since the image doesn't contain the tools, Metasploit Framework, or Empire C2 server, you need to set up and mount them on your own using [volumes](https://docs.docker.com/storage/volumes/)
!!! warning

    Make sure that the `CRYTON_WORKER_MODULES_DIRECTORY` setting contains the default value.

The following command will start the Worker container. It shares the host's networking namespace.
```
docker run --network host -d registry.gitlab.ics.muni.cz:443/cryton/cryton-worker:kali-{{{ release_version }}}
```

!!! warning "Limitations"

    - The easiest way to make the container accessible from the outside and to allow the container to access the prerequisites is to use the `--network host` option
    - Since the image doesn't contain the Metasploit Framework, or Empire C2 server, you need to set up on your own
If you're using Docker (Compose) to install the app, you can ignore this section.
cryton-worker
Usage: cryton-worker [OPTIONS] COMMAND [ARGS]...

  Cryton Worker CLI.

Options:
  ...
cryton-worker <your command> --help
Starting Worker worker..
To exit press CTRL+C
Connection does not exist. Retrying..
Connection to RabbitMQ server established.
[*] Waiting for messages.
Use the `nohup` command:
```shell
nohup cryton-worker start > /tmp/worker_std_out 2>&1 &
```

To **stop** the Worker, find their processes and kill them:
```shell
ps -aux | grep cryton-worker
kill <PID> <PID>
```
- To enable the shell completion, the tool must be present
- The shell completion is enabled in Docker by default
```shell
mkdir -p ~/.local/cryton-worker/
```
```shell
mkdir -p ~/.local/cryton-worker/
```
```shell
_CRYTON_WORKER_COMPLETE=bash_source cryton-worker > ~/.local/cryton-worker/cryton-worker-complete.bash
echo ". ~/.local/cryton-worker/cryton-worker-complete.bash" >> ~/.bashrc
```
```shell
_CRYTON_WORKER_COMPLETE=zsh_source cryton-worker > ~/.local/cryton-worker/cryton-worker-complete.zsh
echo ". ~/.local/cryton-worker/cryton-worker-complete.zsh" >> ~/.zshrc
```
```shell
_CRYTON_WORKER_COMPLETE=fish_source cryton-worker > ~/.config/fish/completions/cryton-worker-complete.fish
```