Skip to content

Commit e2d26a3

Browse files
committed
[docs] Add StarterPack doc
1 parent e48fdae commit e2d26a3

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

docs/deployment/configuration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ Here are the configuration keys, for both containers (environment variables) and
3939
| openbas.admin.token | OPENBAS_ADMIN_TOKEN | ChangeMe | Default token (must be a valid UUIDv4) |
4040
| openbas.healthcheck.key | OPENBAS_HEALTHCHECK_KEY | ChangeMe | The key to use in the health check endpoint (/api/health) |
4141
| 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. |
42+
| openbas.starterpack.enabled | OPENBAS_STARTERPACK_ENABLED | true | StarterPack feature, providing default endpoint, asset group, scenarios and dashboards |
43+
4244

4345
#### Network and security
4446

@@ -233,4 +235,4 @@ required. You can find a guide [here](https://support.google.com/accounts/answer
233235
| ai.endpoint | AI_ENDPOINT | | Endpoint URL (empty means default cloud service) |
234236
| ai.token | AI_TOKEN | | Token for endpoint credentials |
235237
| ai.model | AI_MODEL | | Model to be used for text generation (depending on type) |
236-
| ai.model_images | AI_MODEL_IMAGES | | Model to be used for image generation (depending on type) |
238+
| ai.model_images | AI_MODEL_IMAGES | | Model to be used for image generation (depending on type) |

docs/usage/getting-started.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,21 @@ Here are some examples of use cases:
2424
The welcome page provides every OpenBAS platform visitor with a snapshot of the platform activity as well as an overview
2525
of your global security posture. You can find more information in [this section](evaluate/overview.md).
2626

27+
## Starter Pack
28+
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.
29+
30+
Will be created :
31+
32+
- Three scenarios (Tabletop, Technical Agentless, Technical Agent based)
33+
- Four dashboards (Technical Home and Scenario, Technical Simulation, TTX Home and Scenario, TTX Simulation)
34+
- Ready to use Payloads (Filigran)
35+
- Ready to use Injects (NMAP and Nuclei)
36+
- All Filigran Collectors (Mitre Attack, Atomic Red Team, OpenAEV, CVE by NVD Nist)
37+
- One Endpoint agentless
38+
- One Asset Group "All endpoint"
39+
40+
You can find configuration to disable it in [this section](../deployment/configuration.md).
41+
2742
## Your first Breach and Attack Simulation
2843

2944
### Creating or Importing players and assets to play with

0 commit comments

Comments
 (0)