Scenarios
By the end of this page you know what a training scenario is, what it never captures, and how to add your own.
A scenario is the content of a simulation: the email a target receives, the landing page a click leads to, and the awareness page that teaches the warning signs afterward. Scenarios ship with redfish and you can write your own.
Shipped scenarios
Section titled “Shipped scenarios”redfish ships with a set of ready-to-use scenarios in the scenarios/ folder. The shipped scenarios are written for a French-speaking audience (locale: fr) and cover common lures such as an unpaid invoice, a parcel delivery, a bank message and a workplace account prompt. You can use them as they are, or as a starting point for your own.
How a scenario is laid out
Section titled “How a scenario is laid out”Each scenario is one folder under scenarios/<key>/ with four files:
| File | Content |
|---|---|
manifest.yaml | Metadata: key, title, category, locale, difficulty, tags, the email subject, the fromName, and the names of the three template files. |
email.mjml | The email, written in MJML so it renders well across mail clients. |
landing.html | The page a click leads to. It captures no input, by design. |
awareness.html | The page shown after the click, which explains the warning signs. |
A manifest looks like this:
key: facture-qrtitle: 'Invoice reminder'category: payment-fraudlocale: frdifficulty: mediumtags: - invoice - payment-fraudsubject: 'Second reminder: invoice overdue'fromName: Billingtemplates: email: email.mjml landing: landing.html awareness: awareness.htmlAdd a scenario
Section titled “Add a scenario”- Create a folder
scenarios/<key>/, where<key>matches thekeyin the manifest. - Add
manifest.yaml,email.mjml,landing.htmlandawareness.html. - Keep the landing page free of any input capture. That is the rule the whole project is built on.
- Restart the application. Scenarios are discovered automatically at startup, so a new folder shows up without any further configuration.
Once discovered, the scenario is selectable when you create a campaign.