Merge branch '80-fix-findings-during-deployment-test' into 'dux'

Welcome! Whether you're responsible for technical deployment or facilitating tabletop exercises, this documentation will equip you with the tools and knowledge needed for successful implementation.

</div>

## Important: Pre-Release Documentation!

This documentation is for Dux (currently at version 3.30.3), our upcoming 4.0.X release. As a

development version, it's not fully tested and you may encounter bugs or unexpected behavior.

If you need a stable and thoroughly tested version, we recommend using version 3.0.X – Citadel.

## What is the INJECT Exercise Platform (IXP)?

- An open-source digital platform designed for conducting interactive tabletop exercises.

This page outlines the known issues associated with the platform and provides guidance on how to

resolve or work around them.

## Exercise cannot be started after an outage

### Issue

Cannot start an exercise even though all exercises are stopped.

### Cause

When an exercise is running, a special lockfile is created. This lockfile is deleted automatically

when the exercise is stopped. If the backend server crashes or the server is manually stopped during

a running exercise, this file will not be properly deleted, preventing from starting this specific

exercise again. The server is set up to automatically delete all lockfiles on startup. However, if

this issue persists even after restarting the server, it could be possible that the process failed.

Ensure that no lockfiles are present in the `data` directory with the name `exercise-<ID>.lock`. The

`data` directory is located in the base directory of the backend. These files can be deleted while

the server is running, however only if there are no actual running exercises.

## Editor: The created definition is invalid

### Issue

Leaving the _Content_ field blank during the _Injects preparation_ phase results in the creation of

invalid definitions.

### Cause

In this case, the _content_path_ in _injects.yml_ is set to a non-existing file.

### Solution

During the _Injects preparation_ phase in Editor, make sure to fill in the _Content_ field for all

your injects.

## Editor: Failed to update inject (ConstraintError)

### Issue

When clicking on _Save_ or _Save & Exit_ during the _Injects preparation_ phase, the following error

is shown:

![Failed to update information inject: ConstraintError: Unable to add key to index 'injectInfoId': at least one key does not satisfy the uniqueness requirements. ConstraintError: Unable to add key to index 'injectInfoId': at least one key does not satisfy the uniqueness requirements.](./images/editor-inject-preparation-error.png)

### Cause

When saving the prepared inject for the first time, the creation process triggers twice due to an

error in code. Therefore, the code is trying to create an inject with the same key (id), triggering

the constraint error.

### Solution

Ignore the error.

## Definition validation

### Issue

### 4. Set up the `.env` file in the root directory (`https` or `https-owncert`).

Follow the setup guide [here](./setup.md#environment-variables). Especially make

sure that:

Follow the setup guide [here](./setup.md#environment-variables).

Especially make sure that you update these variables:

- `INJECT_DOMAIN` is set to your desired hostname (the same one you generated

    the certificate for)

- and `INJECT_SECRET_KEY` is changed to a truly random string of characters of

- `INJECT_SECRET_KEY` is changed to a truly random string of characters of

    at least 50 characters.

- `INJECT_DB_PASS` is set to a secure password

### 5. Make sure the prepared scripts are executable.

- `./01-substitute-env.sh`: you can grant the executable permission via

    `chmod +x 01-substitute-env.sh`,

- `./frontend/frontend/substituteEnv.sh`: you can grant the executable

    permission via `chmod +x frontend/frontend/substituteEnv.sh`.

- `./frontend/substituteEnv.sh`: you can grant the executable

    permission via `chmod +x ./frontend/substituteEnv.sh`.

### 6. Run `docker compose up`, or `docker compose up -d` to run the containers in the background.