Merge branch 'fixes' into 'master'

Release fixes

See merge request cryton/cryton-documentation!2

.gitlab-ci.yml

@@ -28,13 +28,14 @@ pages_tag:
     - git config user.email $PROJECT_BOT_USER@gitlab.example.com
     - git fetch origin $PAGES_BRANCH && git checkout -b $PAGES_BRANCH origin/$PAGES_BRANCH || echo "Pages branch not deployed yet."
     - git checkout $CI_COMMIT_SHA
+    - export DOCUMENTATION_VERSION=${CI_COMMIT_TAG%.*}
   script:
-    - poetry run mike deploy -u -p --prefix public -r $HTTPS_REMOTE -b $PAGES_BRANCH $CI_COMMIT_TAG latest
+    - poetry run mike deploy -u -p --prefix public -r $HTTPS_REMOTE -b $PAGES_BRANCH $DOCUMENTATION_VERSION latest
     - poetry run mike set-default -p --prefix public -r $HTTPS_REMOTE -b $PAGES_BRANCH latest
   rules:
     - if: $CI_SERVER_HOST != "gitlab.ics.muni.cz"
       when: never
-    - if: $CI_COMMIT_TAG =~ /^[0-9]+\.[0-9]+$/ && $CI_COMMIT_REF_PROTECTED == "true"
+    - if: $CI_COMMIT_TAG =~ /^[0-9]+\.[0-9]+\.([0-9]|[0-z])+$/ && $CI_COMMIT_REF_PROTECTED == "true"
 
 pages_master:
   stage: build
@@ -76,4 +77,4 @@ pages:
     - if: $CI_SERVER_HOST != "gitlab.ics.muni.cz"
       when: never
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_REF_PROTECTED == "true"
-    - if: $CI_COMMIT_TAG =~ /^[0-9]+\.[0-9]+$/ && $CI_COMMIT_REF_PROTECTED == "true"
+    - if: $CI_COMMIT_TAG =~ /^[0-9]+\.[0-9]+\.([0-9]|[0-z])+$/ && $CI_COMMIT_REF_PROTECTED == "true"

docs/components/cli.md

@@ -145,13 +145,13 @@ Install the app:
 === "pipx"
 
     ```shell
-    pipx install cryton-cli
+    pipx install cryton-cli=={{{ release_version }}}
     ```
 
 === "pip"
 
     ```shell
-    pip install --user cryton-cli
+    pip install --user cryton-cli=={{{ release_version }}}
     ```
 
 ### With Docker

docs/components/core.md

@@ -258,12 +258,13 @@ To make the installation process smoother the prerequisites are bundled within t
     !!! 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"}
 
-    First, you have to create [permanent settings](#settings-permanent). Then, switch to the app directory:
+    Switch to the app directory:
     ```shell
     cd ~/.local/cryton-core/
     ```
@@ -374,13 +375,13 @@ Install the app:
 === "pipx"
 
     ```shell
-    pipx install cryton-core
+    pipx install cryton-core=={{{ release_version }}}
     ```
 
 === "pip"
 
     ```shell
-    pip install --user cryton-core
+    pip install --user cryton-core=={{{ release_version }}}
     ```
 
 ### With Docker

docs/components/modules.md

@@ -33,7 +33,7 @@ git checkout {{{ git_release }}}
 
 Make sure the Worker's app directory exists and copy the modules into it:
 ```shell
-mkdir -p 
+mkdir -p ~/.local/cryton-worker/
 cp -r modules ~/.local/cryton-worker/
 ```
 

docs/components/worker.md

@@ -249,7 +249,6 @@ The easiest way to install Cryton Worker (and its prerequisites) is to use the e
     - Create [permanent settings](#settings-permanent)
     - Update the following settings:
         1. CRYTON_WORKER_MODULES_DIR=/absolute/path/to/modules/
-        2. CRYTON_WORKER_EMPIRE_HOST=cryton-empire
 
 !!! tip "Recommendations"
 
@@ -265,7 +264,13 @@ Install the [modules](modules.md#installation) into the app directory and export
 ```shell
 export CRYTON_WORKER_MODULES_DIR=~/.local/cryton-worker/modules/
 ```
-If you're using persistent settings, make sure that they match.
+
+!!! warning "Make sure that the persistent settings match"
+
+    Check the real value of the variable using:
+    ```shell
+    export | grep CRYTON_WORKER_MODULES_DIR
+    ```
 
 Download the configuration using:
 
@@ -319,20 +324,26 @@ Install the [modules](modules.md#installation) into the app directory and export
 ```shell
 export CRYTON_WORKER_MODULES_DIR=~/.local/cryton-worker/modules/
 ```
-If you're using persistent settings, make sure that they match.
+
+!!! warning "Make sure that the persistent settings match"
+
+    Check the real value of the variable using:
+    ```shell
+    export | grep CRYTON_WORKER_MODULES_DIR
+    ```
 
 Install the app:
 
 === "pipx"
 
     ```shell
-    pipx install cryton-worker
+    pipx install cryton-worker=={{{ release_version }}}
     ```
 
 === "pip"
 
     ```shell
-    pip install --user cryton-worker
+    pip install --user cryton-worker=={{{ release_version }}}
     ```
 
 ### With Docker
@@ -352,7 +363,13 @@ Install the [modules](modules.md#installation) into the app directory and export
 ```shell
 export CRYTON_WORKER_MODULES_DIR=~/.local/cryton-worker/modules/
 ```
-If you're using persistent settings, make sure that they match.
+
+!!! warning "Make sure that the persistent settings match"
+
+    Check the real value of the variable using:
+    ```shell
+    export | grep CRYTON_WORKER_MODULES_DIR
+    ```
 
 Run the container:
 
@@ -364,7 +381,7 @@ Run the container:
 
     The following command ensures effortless deployment. It mounts the modules and shares the host's networking namespace.
     ```
-    docker run --network host -e CRYTON_WORKER_MODULES_DIR=${CRYTON_WORKER_MODULES_DIR} -v ${CRYTON_WORKER_MODULES_DIR}:${CRYTON_WORKER_MODULES_DIR} registry.gitlab.ics.muni.cz:443/cryton/cryton-worker:{{{ release_version }}}
+    docker run --network host -e CRYTON_WORKER_MODULES_DIR=${CRYTON_WORKER_MODULES_DIR} -v ${CRYTON_WORKER_MODULES_DIR}:${CRYTON_WORKER_MODULES_DIR} -d registry.gitlab.ics.muni.cz:443/cryton/cryton-worker:{{{ release_version }}}
     ```
 
     !!! warning "Limitations"
@@ -378,7 +395,7 @@ Run the container:
 
     The following command ensures effortless deployment. It mounts the modules and shares the host's networking namespace.
     ```
-    docker run --network host -e CRYTON_WORKER_MODULES_DIR=${CRYTON_WORKER_MODULES_DIR} -v ${CRYTON_WORKER_MODULES_DIR}:${CRYTON_WORKER_MODULES_DIR} registry.gitlab.ics.muni.cz:443/cryton/cryton-worker:kali-{{{ release_version }}}
+    docker run --network host -e CRYTON_WORKER_MODULES_DIR=${CRYTON_WORKER_MODULES_DIR} -v ${CRYTON_WORKER_MODULES_DIR}:${CRYTON_WORKER_MODULES_DIR} -d registry.gitlab.ics.muni.cz:443/cryton/cryton-worker:kali-{{{ release_version }}}
     ```
 
     !!! warning "Limitations"

docs/dynamic-execution.md

@@ -39,13 +39,13 @@ Download the example script:
 === "curl"
 
     ```shell
-    curl -O {{{config.site_url}}}{{{ release_version }}}/dynamic_example.py
+    curl -O {{{ config.site_url }}}dynamic_example.py
     ```
 
 === "wget"
 
     ```shell
-    wget {{{config.site_url}}}{{{ release_version }}}/dynamic_example.py
+    wget {{{ config.site_url }}}dynamic_example.py
     ```
 
 Update the `WORKER_ID` variable, and run the script:

docs/getting-started/docker-compose.yml

@@ -5,7 +5,7 @@ services:
     image: registry.gitlab.ics.muni.cz:443/cryton/cryton-core:{{{ release_version }}}
     container_name: cryton-core
     ports:
-      - "8000:80"
+      - "127.0.0.1:8000:80"
     env_file:
       - .env
     depends_on:
@@ -50,8 +50,7 @@ services:
     restart: always
     image: bcsecurity/empire:v4.10.0
     container_name: cryton-empire
-    expose:
-      - "1337"
+    network_mode: host
     env_file:
       - .env
     stdin_open: true

docs/getting-started/.env → docs/getting-started/env

@@ -12,15 +12,12 @@ CRYTON_CORE_API_USE_STATIC_FILES=true
 
 CRYTON_WORKER_NAME=local_worker
 CRYTON_WORKER_MODULES_DIR=/opt/modules/
-CRYTON_WORKER_MSFRPCD_HOST=127.0.0.1
 CRYTON_WORKER_MSFRPCD_PORT=55553
 CRYTON_WORKER_MSFRPCD_SSL=true
 CRYTON_WORKER_MSFRPCD_USERNAME=cryton
 CRYTON_WORKER_MSFRPCD_PASSWORD=cryton
-CRYTON_WORKER_RABBIT_HOST=cryton-rabbit
 CRYTON_WORKER_RABBIT_USERNAME=cryton
 CRYTON_WORKER_RABBIT_PASSWORD=cryton
-CRYTON_WORKER_EMPIRE_HOST=cryton-empire
 CRYTON_WORKER_EMPIRE_USERNAME=cryton
 CRYTON_WORKER_EMPIRE_PASSWORD=cryton
 

docs/getting-started/quick-start.md

@@ -42,19 +42,19 @@ Download the .env file (settings):
 === "curl"
 
     ```shell
-    curl -O {{{config.site_url}}}{{{ release_version }}}/getting-started/.env
+    curl -o .env {{{ config.site_url }}}getting-started/env
     ```
 
 === "wget"
 
     ```shell
-    wget {{{config.site_url}}}{{{ release_version }}}/getting-started/.env
+    wget -O .env {{{ config.site_url }}}getting-started/env
     ```
 
 ??? abstract "Show the .env file"
 
     ```ini
-    {! include ".env" !}
+    {! include "env" !}
     ```
 
 Download the Compose configuration:
@@ -62,13 +62,13 @@ Download the Compose configuration:
 === "curl"
 
     ```shell
-    curl -O {{{config.site_url}}}{{{ release_version }}}/getting-started/docker-compose.yml
+    curl -O {{{ config.site_url }}}getting-started/docker-compose.yml
     ```
 
 === "wget"
 
     ```shell
-    wget {{{config.site_url}}}{{{ release_version }}}/getting-started/docker-compose.yml
+    wget {{{ config.site_url }}}getting-started/docker-compose.yml
     ```
 
 ??? abstract "Show the Compose config"

docs/integrated-tools/empire.md

@@ -7,7 +7,7 @@ Description of [Empire](https://github.com/BC-SECURITY/Empire){target="_blank"}
 </ol>
 
 ## requirements for usage with Core:
-- Installed and running Empire server with version 4.1.0 and above. Installation guide 
+- Installed and running Empire server with version **4.x.x**. Installation guide 
 [here](https://bc-security.gitbook.io/empire-wiki/quickstart/installation){target="_blank"}
 - Installed all main Cryton components, that is [Core](../components/core.md), [Worker](../components/worker.md) and
 [Cli](../components/cli.md)

docs/production.md

@@ -13,7 +13,7 @@ Hide the rest API behind a proxy with restricted access.
 
 !!! tip
 
-    Use the officially supplied docker-compose.yml and add a .htaccess file to it.
+    Use the officially supplied docker-compose.yml.
 
 ## Worker
 ### Settings