Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 46 additions & 2 deletions docs/administration/parameters.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,49 @@
# Parameters

!!! tip "Under construction"
The Parameters section lets administrators configure global options of the OpenBAS platform, including license,
appearance, tools, and onboarding settings.

We are doing our best to complete this page. If you want to participate, don't hesitate to join the [Filigran Community on Slack](https://community.filigran.io) or submit your pull request on the [Github doc repository](https://github.com/OpenBAS-Platform/docs).
## Enterprise edition

This section provides information about the organization and the deployment scope.

[Learn More](./openbas-agent.md)

## Configuration

Allows you to set the global identity of your platform.

* Platform name → Name displayed in the header.
* Default theme → Default theme for the interface.
* Default language → Default language for the interface.

## OpenBAS platform

Provides technical identifiers and edition information.

* Platform identifier → Unique identifier of your instance.
* Version → Installed version of OpenBAS (e.g. *1.18.4*).
* Edition → Installed edition (e.g. *Enterprise*).
* AI Powered → Indicates if AI features are enabled.

## Theme customization

Both Dark theme and Light theme can be customized independently.

## Tools

This section provides administrators with the status and version information of the different tools used by the
platform.

![tools](assets/parameters/tools.png)

## Help settings

This section controls the onboarding and tutorial experience for users.

* Onboarding process

* Display Onboarding Widget → Show or hide the onboarding checklist in the left menu.
* Display contextual “Set up” guides → Enable or disable contextual tutorial videos.

![help-settings](assets/parameters/help-settings.png)
45 changes: 45 additions & 0 deletions docs/usage/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,51 @@ Here are some examples of use cases:
- Organize Capture The Flag with multiple challenges
- Conduct atomic testing

## Onboarding

The onboarding feature helps new users discover OpenBAS step by step, by guiding
them through essential configurations and workflows.

### Welcome popup

When you log in to OpenBAS for the first time, a **welcome popup** is displayed.
This popup introduces you to the platform and lists all available tutorial videos.
It is designed to give you a quick overview of the main concepts and help you
take your first steps with confidence.

![welcome-popup](assets/onboarding/welcome-popup.png)

### Contextual videos

On specific pages, you can trigger a contextual video tutorial that explains the
concepts and actions to perform:

- Discover OpenBAS
- Set up an endpoint
- Set up a collector
- Set up a player
- Set up a team
- Launch a scenario and understand your results

![contextual-video](assets/onboarding/contextual-video.png)

You can enable or disable these tutorials in your **platform settings** or in
your **user profile settings**.

### Getting started checklist

The onboarding wizard provides a **progress bar** showing the key actions you
need to complete before running your first scenario.

- Each task links directly to the relevant page and triggers its tutorial video.
- Completed actions are automatically marked as **done** in the wizard.
- Actions can also be skipped if you prefer to configure them later.

This checklist ensures you have everything set up before launching your first
Breach and Attack Simulation.

![checklist](assets/onboarding/checklist.png)

## Welcome dashboard

The welcome page provides every OpenBAS platform visitor with a snapshot of the platform activity as well as an overview
Expand Down