Skip to content

readme #195

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
ahenao4 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

readme #195

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
24 changes: 20 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# MITRE Caldera Plugin: Training

The training plugin provides a certification course to become a Caldera subject matter expert (SME)
## Overview:

If you earn a code, submit the code to this form to obtain a certificate: https://forms.office.com/g/sYRNDuxCjC.
The Training plugin provides interactive training and certification content. This plugin allows a user to gain a “User Certificate” which proves their ability to use Caldera. This is the first of several certificates planned in the future. The plugin takes you through a capture-the-flag style certification course, covering all parts Caldera.

## Development
### Context:
Training content and certification

<!-- ### Known Limitations: -->

## Installation:

This is a core CALDERA plugin and is loaded by default via the plugin loader. Ensure it is present in the `plugins/` directory and listed as enabled in your active configuration file (e.g., `conf/default.yml`).

## Dependencies/Requirements:

### JavaScript:
This plugin uses `eslint` for javascript linting and requires the following dependencies:

* `node >= 15.9.0`
Expand All @@ -30,3 +38,11 @@ To fix issues automatically run the following (note: not all violations can be f
```

For information about rule violations, see the [eslint rules](https://eslint.org/docs/rules/) page.

## Getting Started:

To begin using the Training plugin, navigate to the Training section in the CALDERA UI after starting the server. From there, select a training module or certification track and start with the first flag. The flags are designed to build progressively, so it’s recommended to complete them in order.

If you get stuck, solution guides are available for each flag and can be used to help clarify necessary steps.

**Important**: When running CALDERA during completion of a training module, do not start the server with the --fresh flag. Doing so will reset the environment and result in loss of progress.
Loading