Skip to content

[docs] Add StarterPack doc #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] Add StarterPack doc #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/deployment/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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) |
15 changes: 15 additions & 0 deletions docs/usage/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down