Added the copilot module to the repo including the docs and instruction instructions. Updated all old references to Cases with NC3.

Author: ruslanbaidan

.env.dev

@@ -37,3 +37,14 @@ STATS_SECRET_KEY=changeme_generate_random_secret_key_for_production
 # Stats API Key - Leave empty on first run, it will be generated by the stats service
 # After first run, get it from the stats service logs or container
 STATS_API_KEY=
+
+# Copilot Configuration
+IS_COPILOT_ENABLED=0
+COPILOT_OLLAMA_ENABLED=1
+COPILOT_OLLAMA_TRANSPORT=openai-chat
+COPILOT_OLLAMA_BASE_URL=http://127.0.0.1:11434
+COPILOT_OLLAMA_ENDPOINT_PATH=/chat/completions
+COPILOT_OLLAMA_MODEL=llama-70b
+COPILOT_OLLAMA_API_KEY=
+COPILOT_OLLAMA_JSON_MODE=0
+COPILOT_OLLAMA_TIMEOUT=20

.gitignore

@@ -27,4 +27,4 @@ data/*
 .env
 .docker-initialized
 docker/db_data
-.vscode
+.vscode

CHANGELOG.md

@@ -619,7 +619,7 @@ MONARC Changelog
 - the MONARC core objects (assets, threats, vulnerabilities and risks) are now
   identified with UUIDs. We published the objects on the
   [MONARC objects sharing platform](https://objects.monarc.lu). Risks from
-  the CASES models are also [available](https://objects.monarc.lu/schema/16);
+  the NC3 models are also [available](https://objects.monarc.lu/schema/16);
 - Assets, threats, vulnerabilities, risks and referentials can be imported
   in the knowledge base of your analysis from MOSP without leaving the MONARC
   user interface.

INSTALL/INSTALL.debian10.md

@@ -139,9 +139,8 @@ In your MariaDB interpreter:
     MariaDB [(none)]> CREATE DATABASE monarc_cli DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
     MariaDB [(none)]> CREATE DATABASE monarc_common DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
 
-* monarc_common contains models and data created by CASES;
-* monarc_cli contains all client risk analyses. Each analysis is based on CASES
-  model of monarc_common.
+* monarc_common contains models and data created by NC3;
+* monarc_cli contains all client risk analyses. Each analysis is based on NC3 model of monarc_common.
 
 ### Initializes the database
 

INSTALL/INSTALL.ubuntu1604.md

@@ -126,9 +126,8 @@ There are 2 parts:
     CREATE DATABASE monarc_cli DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
     CREATE DATABASE monarc_common DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
 
-* monarc_common contains models and data created by CASES;
-* monarc_cli contains all client risk analyses. Each analysis is based on CASES
-  model of monarc_common.
+* monarc_common contains models and data created by NC3;
+* monarc_cli contains all client risk analyses. Each analysis is based on NC3 model of monarc_common.
 
 ### Initializes the database
 

INSTALL/INSTALL.ubuntu1804.md

@@ -136,9 +136,8 @@ In your MariaDB interpreter:
     MariaDB [(none)]> CREATE DATABASE monarc_cli DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
     MariaDB [(none)]> CREATE DATABASE monarc_common DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
 
-* monarc_common contains models and data created by CASES;
-* monarc_cli contains all client risk analyses. Each analysis is based on CASES
-  model of monarc_common.
+* monarc_common contains models and data created by NC3;
+* monarc_cli contains all client risk analyses. Each analysis is based on NC3 model of monarc_common.
 
 ### Initializes the database
 

INSTALL/INSTALL.ubuntu2004.md

@@ -130,9 +130,8 @@ MariaDB [(none)]> CREATE DATABASE monarc_cli DEFAULT CHARACTER SET utf8 DEFAULT
 MariaDB [(none)]> CREATE DATABASE monarc_common DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
 ```
 
-* monarc_common contains models and data created by CASES;
-* monarc_cli contains all client risk analyses. Each analysis is based on CASES
-  model of monarc_common.
+* monarc_common contains models and data created by NC3;
+* monarc_cli contains all client risk analyses. Each analysis is based on NC3 model of monarc_common.
 
 ### Initializes the database
 

INSTALL/INSTALL.ubuntu2204.md

@@ -160,9 +160,8 @@ CREATE DATABASE monarc_cli DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_gener
 CREATE DATABASE monarc_common DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
 ```
 
-* monarc_common contains models and data created by CASES;
-* monarc_cli contains all client risk analyses. Each analysis is based on CASES
-  model of monarc_common.
+* monarc_common contains models and data created by NC3;
+* monarc_cli contains all client risk analyses. Each analysis is based on NC3 model of monarc_common.
 
 ### Initializes the database
 

INSTALL/INSTALL.ubuntu2404.md

@@ -123,8 +123,8 @@ CREATE DATABASE monarc_cli DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_gener
 CREATE DATABASE monarc_common DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
 ```
 
-* monarc_common contains models and data created by CASES;
-* monarc_cli contains all client risk analyses. Each analysis is based on CASES model of monarc_common.
+* monarc_common contains models and data created by NC3;
+* monarc_cli contains all client risk analyses. Each analysis is based on NC3 model of monarc_common.
 
 ## 4.3 Initialize the database
 
@@ -185,6 +185,71 @@ php ./vendor/robmorgan/phinx/bin/phinx seed:run -c ./module/Monarc/FrontOffice/m
 The username is *admin@admin.localhost* and the password is *admin*.
 
 
+## 4.7 Enable Copilot (optional)
+
+Recent FrontOffice releases already include the `monarc/copilot` Composer dependency. For custom source deployments, ensure dependencies are installed:
+
+```bash
+composer install
+```
+
+Create the Laminas module symlink:
+
+```bash
+cd /var/lib/monarc/fo
+mkdir -p module/Monarc
+ln -sfn ./../../vendor/monarc/copilot module/Monarc/Copilot
+```
+
+Enable the feature flag in `config/autoload/local.php`:
+
+```php
+    'isCopilotEnabled' => true,
+```
+
+Create the Copilot runtime configuration:
+
+```bash
+cp ./config/autoload/copilot.local.php.dist ./config/autoload/copilot.local.php
+nano ./config/autoload/copilot.local.php
+```
+
+Example configuration:
+
+```php
+<?php
+
+return [
+    'copilot' => [
+        'ollama' => [
+            'enabled' => true,
+            'transport' => 'openai-chat',
+            'baseUrl' => 'http://127.0.0.1:11434',
+            'endpointPath' => '/chat/completions',
+            'model' => 'llama-70b',
+            'apiKey' => '',
+            'jsonMode' => false,
+            'timeout' => 20,
+        ],
+    ],
+];
+```
+
+Refresh the linked frontend resources:
+
+```bash
+./scripts/update-all.sh -d
+```
+
+Restart Apache:
+
+```bash
+sudo apachectl restart
+```
+
+After login, the `Show copilot` button is available on ANR pages when `isCopilotEnabled` is enabled and the configured LLM endpoint is reachable.
+
+
 # 5. Statistics for Global Dashboard
 
 If you would like to use the global dashboard stats feature, you need to

README.docker.md

@@ -97,6 +97,24 @@ This guide explains how to set up a local development environment for MONARC Fro
    - Username: `admin@admin.localhost`
    - Password: `admin`
 
+8. **(Optional) Enable Copilot**:
+   Edit `.env` and configure the Copilot variables:
+   ```bash
+   IS_COPILOT_ENABLED=1
+   COPILOT_OLLAMA_ENABLED=1
+   COPILOT_OLLAMA_TRANSPORT=openai-chat
+   COPILOT_OLLAMA_BASE_URL=http://127.0.0.1:11434
+   COPILOT_OLLAMA_ENDPOINT_PATH=/chat/completions
+   COPILOT_OLLAMA_MODEL=llama-70b
+   COPILOT_OLLAMA_API_KEY=
+   COPILOT_OLLAMA_JSON_MODE=0
+   COPILOT_OLLAMA_TIMEOUT=20
+   ```
+   Then restart the application container:
+   ```bash
+   docker compose -f docker-compose.dev.yml restart monarcfoapp
+   ```
+
 ## Services
 
 The development environment includes the following services:
@@ -230,6 +248,31 @@ docker compose -f docker-compose.dev.yml down -v
 
 ## Common Tasks
 
+### Enabling Copilot
+
+The Docker entrypoint prepares Copilot automatically on startup:
+
+- creates `module/Monarc/Copilot`
+- writes `config/autoload/copilot.local.php` from environment variables
+- recreates `public/js/copilot/CopilotWidget.js`
+- recreates `public/css/copilot/copilot.css`
+
+To enable the UI:
+
+1. Set `IS_COPILOT_ENABLED=1` in `.env`
+2. Point `COPILOT_OLLAMA_BASE_URL` to a reachable LLM endpoint
+3. Restart the application container:
+   ```bash
+   docker compose -f docker-compose.dev.yml restart monarcfoapp
+   ```
+
+If the Copilot button is still missing, verify:
+
+- `docker compose -f docker-compose.dev.yml exec monarcfoapp ls -l module/Monarc/Copilot`
+- `docker compose -f docker-compose.dev.yml exec monarcfoapp ls -l public/js/copilot public/css/copilot`
+- `docker compose -f docker-compose.dev.yml exec monarcfoapp cat config/autoload/copilot.local.php`
+- `docker compose -f docker-compose.dev.yml logs monarcfoapp`
+
 ### Using BackOffice monarc_common
 
 To reuse the BackOffice `monarc_common` database: