From e2d26a30fa6458693fb2b9643af29d6eaa8be4e4 Mon Sep 17 00:00:00 2001 From: Gabriel PEZE Date: Mon, 15 Sep 2025 14:33:49 +0200 Subject: [PATCH] [docs] Add StarterPack doc --- docs/deployment/configuration.md | 4 +++- docs/usage/getting-started.md | 15 +++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/deployment/configuration.md b/docs/deployment/configuration.md index 36f0a57..0e0deef 100644 --- a/docs/deployment/configuration.md +++ b/docs/deployment/configuration.md @@ -39,6 +39,8 @@ Here are the configuration keys, for both containers (environment variables) and | openbas.admin.token | OPENBAS_ADMIN_TOKEN | ChangeMe | Default token (must be a valid UUIDv4) | | openbas.healthcheck.key | OPENBAS_HEALTHCHECK_KEY | ChangeMe | The key to use in the health check endpoint (/api/health) | | inject.execution.threshold.minutes | INJECT_EXECUTION_THRESHOLD_MINUTES | 10 | Inject execution threshold in minutes. If this time is exceeded, the inject will be moved to the MAYBE_PREVENTED status. | +| openbas.starterpack.enabled | OPENBAS_STARTERPACK_ENABLED | true | StarterPack feature, providing default endpoint, asset group, scenarios and dashboards | + #### Network and security @@ -233,4 +235,4 @@ required. You can find a guide [here](https://support.google.com/accounts/answer | ai.endpoint | AI_ENDPOINT | | Endpoint URL (empty means default cloud service) | | ai.token | AI_TOKEN | | Token for endpoint credentials | | ai.model | AI_MODEL | | Model to be used for text generation (depending on type) | -| ai.model_images | AI_MODEL_IMAGES | | Model to be used for image generation (depending on type) | +| ai.model_images | AI_MODEL_IMAGES | | Model to be used for image generation (depending on type) | \ No newline at end of file diff --git a/docs/usage/getting-started.md b/docs/usage/getting-started.md index 6f33053..355a172 100644 --- a/docs/usage/getting-started.md +++ b/docs/usage/getting-started.md @@ -24,6 +24,21 @@ Here are some examples of use cases: The welcome page provides every OpenBAS platform visitor with a snapshot of the platform activity as well as an overview of your global security posture. You can find more information in [this section](evaluate/overview.md). +## Starter Pack +Enabled by default, and in order to understand the value of OpenAEV, the Starter Pack will create and provide for you a set of items for a ready to use platform. + +Will be created : + +- Three scenarios (Tabletop, Technical Agentless, Technical Agent based) +- Four dashboards (Technical Home and Scenario, Technical Simulation, TTX Home and Scenario, TTX Simulation) +- Ready to use Payloads (Filigran) +- Ready to use Injects (NMAP and Nuclei) +- All Filigran Collectors (Mitre Attack, Atomic Red Team, OpenAEV, CVE by NVD Nist) +- One Endpoint agentless +- One Asset Group "All endpoint" + +You can find configuration to disable it in [this section](../deployment/configuration.md). + ## Your first Breach and Attack Simulation ### Creating or Importing players and assets to play with