# Knowledge Base
Welcome to Cyberaware Security Knowledge Base.
## Moving on
All good? Let's explore some of the main concepts, starting with **Dashboard**.
# Getting Started
## Getting Started Guide
In this article, we provide you with the **first steps** you should follow to efficiently use **CYBERAWARE SECURITY** and its **tools.** This is essentially an introductory guidance that will enable you to establish the **foundation** needed **prior** to **testing** and **utilising** the functionalities of the platform.
**1.** As a first step, it is a must that a **whitelisting** of **our mail servers** is in place as long as you are using our **default SMTP servers.** This will ensure that emails within the scope of **student notifications** or [Email Campaigns](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns) targeting your company will not be regarded as **spam/junk.** If your organisation is using **Microsoft 365,** please refer to our article called [Microsoft 365 Whitelist](https://docs.cyberawaresecurity.com/tips-and-tricks/microsoft-365-whitelist). Otherwise, please have a look at our [Whitelist IPs and Domains](https://docs.cyberawaresecurity.com/tips-and-tricks/whitelist-ips-and-domains) article as it provides the appropriate **hostnames** and **IPs** for whitelisting.
**2.** As a next, you will have to add some [Authorised Domains](https://docs.cyberawaresecurity.com/admin-portal/authorised-domains) that you own and exist under your **DNS server.** If the configuration is successful and the platform recognises them as verified legitimate domains, it will allow you to initiate and perform training and email campaigns.
**3.** Now, it is time to enable the [Student Notifications](https://docs.cyberawaresecurity.com/admin-portal/student-notifications). This feature is responsible for sending out **certain email** formats to **recipients** when **specific events** are triggered. Such events can be the creation of their CYBERAWARE SECURITY accounts or their assignment to [Training Campaigns](https://docs.cyberawaresecurity.com/admin-portal/training-campaigns). As mentioned earlier, for the notifications you can always use your **own custom** [SMTP Profiles](https://docs.cyberawaresecurity.com/admin-portal/smtp-profiles) or just settle with the default one we provide.
**4.** Last but not least, to actually perform any sort of campaign and distribute the necessary **courses** or **emails,** you will need to add the intended targets. Anyone (**explicitly within** your organisation) can be a recipient, as long as they are required to enhance their **cybersecurity awareness** or be tested against their **phishing detection** skills. Click on this [link](https://docs.cyberawaresecurity.com/admin-portal/recipients) to learn further information regarding **recipients.**
# Dashboard
## Dashboard Guide
In this article, we explain the different aspects of the **Dashboard** section in the admin portal. It gives us a summary and a general understanding of what is taking place on the platform regarding email campaigns, risk, training results, etc.
**1.** Navigate to **Dashboard:**
**2.** As we can distinguish, the **Dashboard** window is split into many parts. The **first** part shows general details about the **training campaigns** along with a **phishing failure overview.**
**3.** You are actually able to click on the **phishing failure graph** and navigate to any phishing campaign that took place periodically:
To learn more about **email campaigns,** click on the following [link](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns).
**4.** The **second** part presents general details about the **phishing email campaigns** in the form of **graphs:**
**5.** The **next part** of the Dashboard displays the **highest risk** recipients identified in the platform with the help of the risk algorithm:
**6.** Click on the **View All** button to observe the **Risk Report** for the **top 20 riskier** recipients of the portal:
For further information about risk reports, follow this [link](https://docs.cyberawaresecurity.com/admin-portal/reports) to reach the appropriate article.
**7.** We can also **open** the profile of any recipient listed. To do that, let’s go ahead and click on one of these records:
If you wish, you can navigate to the **Recipients** article through this [link](https://docs.cyberawaresecurity.com/admin-portal/recipients).
**8.** The **last** bit of the Dashboard shows the latest email campaigns used to evaluate the **risk score** of the organisation:
**9.** Click on the **drop-down list** to view **more than 10** entries in a single page:
**10.** Select the button shown in the following image to **view** either of the current campaigns.
**11.** Click on the **View All** button to **visit** the **Email Campaigns** section.
You can now view **all** of the available email campaigns:
**12.** Finally, you can tap on the **trash** **can** button next to a campaign in order to **delete** it:
**13.** On the confirmation prompt that pops up, click **OK** to finalise or **Cancel** to reject the action.
# Reports
## Reports Guide
In this segment, we are discussing all available reporting options in the **Reports** section of the admin portal. The **risk score** formula accurately calculates the risk of recipients based on critical factors, such as position in the company, training completed, phish prone level and data breaches. Reporting is a major feature for all corporations and their departments dealing with such matters (ex. Human Resources) and helps distinguish the risk **severity** of employees within the organisation.
# Group Reports Guide
## Group Reports Guide
In this article, we go over all the available options of the **Group Reports.** It contains all **group-oriented** reports like the **report card,** the **riskiest** groups and the **training time** and **phish prone** by groups.
**1.** Navigate to **Reports:**
**2.** Select the **GROUP REPORTS:**
You should get the following output:
**3.** Let’s view the first option called **Group Report Card.** To do this, press on the **View Report** button next to it:
A report card will look like this:
In essence, the report card shares all information you would normally look for in a [Group](https://cyberaware-security.gitbook.io/welcome-to-cyberaware-security/admin-portal/groups) profile, but without further functionality.
**4.** You can choose a specific group from the **drop-down list** to view its **Report Card.**
As an example:
**5.** You may **download** the report for your own use. Just click on **Export PDF:**
It will essentially export a **snapshot** of the report into a **PDF** file format:
**6.** You can always visit a **recipient’s profile** by clicking on their name:
To learn more about recipients, click on the following [link](https://cyberaware-security.gitbook.io/welcome-to-cyberaware-security/admin-portal/recipients).
**7.** Furthermore, you can navigate to a **course** by clicking on their name:
To learn more about **course content,** click on the [Course Catalogue](https://cyberaware-security.gitbook.io/welcome-to-cyberaware-security/admin-portal/course-catalogue) article.
**8.** Alternatively, click on the **Go Back** button to return to the previous directory:
**9.** Let’s move on to the next option of the **Group Reports** called **Riskiest Groups:**
**10.** As with PDF, click on **Export Excel** to download the report for your own use:
**11.** Just like with recipient profiles and courses, we can click on a **Group** to view its stats.
**12.** Moving on to the third option of the **Group Reports** called **Training Time by Group:**
This report includes a **graph** and a **table,** which demonstrate the individual **training activity** of **groups** over **time.** It can help you distinguish the most dedicated/efficient group of employees within your organisation.
**13.** Additionally, we can **filter the graph** to draw specific results. To do that, just **click** on any of the available filtering values:
In this example, we are filtering out the **Solo Group** value:
**14.** Finally, let’s visit the **last** report called **Phish Prone by Group:**
As we can see, this section provides a **graph** along with a **table,** and they display campaign statistics such as the **number of recipients** targeted by the campaigns, the **campaigns’ phish prone percentages** and more.
# Recipient Reports Guide
## Recipient Reports Guide
In this article, we go over all the available options of the **Recipient Reports**. It contains all **recipient-oriented** reports like the **report card,** the **riskiest, unphished** and **untrained** recipients.
**1.** Navigate to **Reports:**
**2.** Select the **RECIPIENT REPORTS:**
You should get the following output:
**3.** Let’s view the first option called **Recipient Report Card.** To do this, press on the **View Report** button next to it:
A report card will look like this:
In essence, the report card shares all information you would normally look for in a [Recipient](https://cyberaware-security.gitbook.io/welcome-to-cyberaware-security/admin-portal/recipients) profile, but without further functionality.
**4.** You can choose a specific recipient from the **drop-down list** to view her/his **Report Card.**
As an example:
**5.** You may **download** the report for your own use. Just click on **Export PDF:**
It will essentially export a **snapshot** of the report into a **PDF** file format:
**6.** You can always visit a **course** by clicking on their name:
To learn more about **course content,** click on the [Course Catalogue](https://cyberaware-security.gitbook.io/welcome-to-cyberaware-security/admin-portal/course-catalogue) article.
**7.** Alternatively, click on the **Go Back** button to return to the previous directory:
**8.** Moving on to the next option of the **Recipient Reports** called **Riskiest Recipients:**
**9.** As with PDF, click on **Export Excel** to download the report for your own use:
**10.** Just like with **courses,** we can visit a **recipient’s profile** by clicking on their name:
**11.** Moving on to the third option of the **Recipient Reports** called **Unphished Recipients:**
This report displays a list of recipients that have not been “phished” yet. It will essentially help you develop a **pending recipients** list for your next [Email Campaigns](https://cyberaware-security.gitbook.io/welcome-to-cyberaware-security/admin-portal/email-campaigns).
**12.** As with courses and recipient profiles, we can click on a **group** to view its stats:
**13.** Finally, let’s visit the **last** report called **No Training Assigned Recipients:**
This report lists all untrained (**potentially new**) employees along with some of their details. Those listed should be used as part of upcoming [Training Campaigns](https://cyberaware-security.gitbook.io/welcome-to-cyberaware-security/admin-portal/training-campaigns).
# Risk Score Reports Guide
## Risk Score Reports Guide
In this article, we cover all available reporting options of the **Risk Score Reports.** The risk score formula calculates accurately the risk of a recipient based on critical factors such as position in the company, training completed, phish prone level and data breaches. Furthermore, these reports go into detail about the **overall organisation risk score** and elaborate further on the **riskiest recipients** and **groups.**
**1.** Navigate to **Reports:**
**2.** Select the **RISK SCORE REPORTS:**
You should get the following output:
**3.** Let’s view the first option called **Organisation Risk Score.** To do this, press on the **View Report** button next to it:
As we can see, the organisation risk score report provides **graphs, table,** and evaluation **details** that can help us distinguish the **risk level** of the organisation, as well as the **contributing factors.**
**4.** The **Score Details** section includes a brief literate observation to help us better understand the **risk score status** of the **organisation.**
**5.** You may **download** the report for your own use. Just click on **Export PDF:**
This will export a **snapshot** of the report into a **PDF** file format:
**6.** On the other hand, you can choose to **Export Excel:**
**7.** Otherwise, click on the **Go Back** button to return to the previous directory:
**8.** Moving on to the next option of the **Risk Score Reports** called **Riskiest Recipients:**
**9.** You can always visit a **recipient’s profile** by clicking on their name:
If you wish, you can navigate to the recipients article through this [link](https://cyberaware-security.gitbook.io/welcome-to-cyberaware-security/admin-portal/recipients).
**10.** Finally, let’s visit the **last** report called **Riskiest Groups:**
**11.** Just like with recipient profiles, we can visit a **group** by clicking on their name:
For further information about groups, follow this [link](https://cyberaware-security.gitbook.io/welcome-to-cyberaware-security/admin-portal/groups) to reach the appropriate article.
# Training Reports Guide
## Training Reports Guide
In this article, we focus on reports that derive from **Training Campaigns. Training Reports** show the overall training statistics of an organisation. In other words, they point out the following and compliance of the personnel regarding custom or provided cybersecurity awareness training courses. Moreover, reports give emphasis on an individual and group level of reporting, as well as the untrained recipients.
**1.** Navigate to **Reports:**
**2.** Select the **TRAINING REPORTS:**
You should get the following output:
**3.** Let’s view the first option called **Training Matrix.** To do this, press on the **View Report** button next to it:
The training matrix displays training details, such as the **courses used** in campaigns, the **recipients targeted** and their **current progress.**
**4.** You may **download** the report for your own use. Just click on **Export Excel:**
This option provides further information such as emails, enrolment date, completion date and time spent on the training:
**5.** On the other hand, you can choose to **Export PDF:**
It will essentially export a **snapshot** of the report into a **PDF** file format:
**6.** You can always visit a **recipient’s profile** by clicking on their name:
**7.** Otherwise, click on the **Go Back** button to return to the previous directory:
**8.** Let’s move on to the next option of the **Training Reports** called **Training Time Overview:**
As this report suggests, it provides us with an **overview** of the **training time**. It presents the fluctuation of the training volume in terms of **time spent** throughout a **timeline.**
**9.** Moving on to the third option of the **Training Reports** called **Training Time by Group:**
This report includes a **graph** and a **table,** which demonstrate the individual **training activity** of **groups** over **time.** It can help you distinguish the most dedicated/efficient group of employees within your organisation.
**10.** Additionally, we can **filter the graph** to draw specific results. To do that, just **click** on any of the available filtering values:
In this example, we are filtering out the **Training Group** value:
**11.** Just like with recipient profiles, we can visit a **group** by clicking on their name:
**12.** Finally, let’s visit the **last** report called **No Training Assigned Recipients:**
This report lists all untrained (**potentially new**) employees along with some of their details. Those listed should be used as part of upcoming [Training Campaigns](https://docs.cyberawaresecurity.com/admin-portal/training-campaigns).
# Phish Prone Reports Guide
## Phish Prone Reports Guide
In this article, we go over the available reports included in **Phish Prone Reports.** The phish prone score is generally calculated through a formula that takes as input all **actions/mistakes** made by recipients during a phishing campaign such as clicking on links, entering credentials, or opening attachments. Ultimately, the article covers the overall phish prone status of a company and later elaborates on a group and campaign level of reporting.
**1.** Navigate to **Reports:**
**2.** Select the **PHISH PRONE REPORTS:**
You should get the following output:
**3.** Let’s view the first option called **Phish Prone Overview.** To do this, press on the **View Report** button next to it:
As indicated, this report calculates the phish prone level of the organisation based on **past** and **current** campaigns to provide us with an **overview** throughout time. Of course, this risk factor fluctuates as employees come and go, but also improves or worsens based on their performance during [Email Campaigns](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns).
**4.** You may **download** the report for your own use. Just click on **Export PDF:**
It will essentially export a **snapshot** of the report into a **PDF** file format:
**5.** You can always click on the **Go Back** button to return to the previous directory:
**6.** Let’s move on to the next option of the **Phish Prone Reports** called **Phish Prone by Group:**
As we can see, this section provides a **graph** along with a **table,** and they display campaign statistics such as the **number of recipients** targeted by the campaigns, the **campaigns’ phish prone percentages** and more.
**7.** Additionally, we can **filter the graph** to draw specific results. To do that, just **click** on any of the available filtering values:
In this example, we are filtering out the **Any Group** value:
**8.** You can always visit a **group** by clicking on their name:
**9.** Finally, let’s visit the **last** report called **Phish Prone by Campaigns:**
**10.** Just like with groups, we can click on a **Campaign** to view its stats.
# Phishing Reports
## Phishing Reports Guide
In this article, we cover the different reports we can view regarding **Email Campaigns. Phishing Reports** are available for users of the admin portal and will provide statistics that are very much a necessity to all organisations and their reporting responsible departments, such as Human Resources, etc. This report focuses on **Phishing Campaigns** related analysis and can assist companies identify the most common mistakes made by their personnel as well as point out all employees that have not been “phished” yet.
**1.** Navigate to **Reports:**
**2.** Select the **PHISHING REPORTS:**
You should get the following output:
**3.** You can always click on the **Go Back** button to return to the previous directory:
**4.** Let’s view the first option called **Email Campaign Report Card.** To do this, press on the **View Report** button next to it:
A report card will look like the below. Before exporting a report, you may apply different filters such as the Recipient Position, the Department, Division, Location and for which campaign to export a report.
**5.** You may **download** the report for your own use. Just click on **Export PDF** or **Export Excel:**
It will essentially export a **snapshot** of the report into a **PDF** file format:
**6.** In general, at the **top** of the report, we can see various **Campaign Details** such as **dates, addresses** and **phishing methods** (**attachments** and/or **landing pages**) used.
**7.** On the other hand, middle section of the report provides statistics about **Campaign Failures** such as estimated **Failure** (phish prone) **Percentage** and **Phishing Failures** which displays the target recipients along with their various actions.
**8.** The **Recipient Status,** which is found at the bottom of the report, shows different recipient related information as well as the **final actions** (**Opened Attachment**) taken by that recipient during the phishing campaign:
**9.** You can always visit a **recipient’s profile** by clicking on their name:
**10.** Same thing applies for **groups:**
**11.** Let’s move on to the next option of the **Phishing Reports** called **Phishing Failures by Campaigns:**
As we can see, this section provides a **graph** along with a **table,** and they display campaign statistics such as the **number of recipients** targeted by the campaigns, the **campaigns’ phish prone percentages** and more.
**12.** Additionally, we can **filter the graph** to draw specific results. To do that, just **click** on any of the available filtering values:
In this example, we are filtering all campaigns out of all the available options except the **Attachments Opened** value:
**13.** As with recipient profiles and groups, we can click on a **Campaign** to view its stats.
**14.** Finally, let’s visit the **last** phishing report called **Unphished Recipients:**
This report displays a list of recipients that have not been “phished” yet. It will essentially help you develop a **pending recipients** list for your next [Email Campaign](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns).
# Email Campaigns
## Email Campaigns Guide
In this article, we explain the process of creating and initiating **Email Campaigns.** With these campaigns, companies can distribute phishing emails to their employees in order to evaluate whether they pose any potential risk to the organisation.
{% embed url="" %}
**1.** To create a **new** Email Campaign, click on the **New Campaign** button.
**2.** Enter a **Campaign Name:**
**3.** Even though it is optional, we suggest that during the campaigns you add a “clickers” group. This is essentially where all the clickers (any user that clicks on any links included in the phishing campaign) will be stored. Thus, it is preferred to use an **empty** group so you can distinguish the high-risk employees.
To learn more about groups, click on the following [link](https://docs.cyberawaresecurity.com/admin-portal/groups) for the corresponding article.
**4.** You can also enter a **Description:**
**5.** For demonstration purposes, we entered the details and selected an empty group called **Recipients.**
**6.** Let’s click on **NEXT STEP** to proceed to the **Templates** phase:
Alternatively, we can navigate to the next step(s) by directly selecting them.
**7.** Select **Use specific template**, then click **Select template** to manually choose the email template for your campaign. This template defines the content recipients will receive when the email campaign is delivered.
Alternatively, you can enable **Use randomized template**. When this option is selected, the system automatically chooses different templates for each recipient from the available system templates. Template selection is based on the language specified in each recipient’s profile, ensuring recipients receive content in the appropriate language without any manual configuration. This helps personalise campaigns at scale while maintaining consistent language targeting.
**8.** In this instance, we don’t have any custom templates, but we can use any of the system templates:
**9.** Scroll at the bottom and select different pages to list other templates:
**10.** You can always filter the templates from the search box or through the filtering options in the menu:
**11.** Let’s use the **Booking** template:
**12.** Click **OK** to confirm your choice or **Cancel** to negate the process.
**13.** After the confirmation, we get the following preview:
You can alternatively create and use custom email templates. For further guidance regarding email templates click on this [link](https://docs.cyberawaresecurity.com/admin-portal/email-templates).
**14.** To select a landing page, click on the **Select page** button:
**15.** As always, you can select a custom template but, in our case, we will select one from the system templates:
**16.** Let’s use the matching landing page of the email template for **Booking:**
**17.** Click on the indicated option to open the landing page in a new tab on the browser.
This will display how the user actually sees the corresponding page:
**18.** To disable the landing page, just click on the following button:
**19.** Furthermore, you have the option to use an attachment payload. To do this, just click on the indicated box:
**20.** Click on **Add** to view the available options:
**21.** You can also set a custom name for that file, so it appears as a normal document they would expect:
**22.** For this example, let us use both a landing page and an attachment:
**23.** You can click on the **trash can** symbol to remove the file:
**24.** Moreover, you can tick the following box in order to redirect the target user. If the target accesses the attached document which contains the macros, they will be redirected to the specified landing page for that campaign:
**25.** When you finish the process, scroll to the bottom of the page, and click on **NEXT STEP** to proceed or **PREVIOUS** to go back to the previous step.
**26.** Proceed to the next step called **Recipients:**
**27.** Select the target group for the campaign.
**28.** You may selectively **add** or **remove** specific users from the campaign just by ticking or unticking the boxes found beside their records:
For this example, we will leave everything as it is and will proceed to the **Schedule** step:
**29.** From the following option, we can select the **Launch Date** for the campaign. In other words, the starting time initiating the phishing email distribution.
**30.** Furthermore, we can set the **through date** for the phishing campaign. No further emails will be sent afterwards.
The platform calculates the number of emails to be distributed in relation to the campaign interval frame and sends the phishing emails accordingly.
**31.** Select a **Timezone** for the campaign and proceed to the final step.
**32.** Click on the indicated button to view the landing page instead:
**33.** Once again, click on the following button to view the landing page on your browser:
**34.** Scroll down and select the **URL** for your landing page. Different domains are available:
**35.** In this instance, we’ve chosen the **** domain and the default **SMTP** sending profile:
If you would like to use a **Default Profile** for the SMTP sending profile, you will then have to **whitelist** the corresponding **hostname** and **IP** address.
**36.** Alternatively, you may select a **Custom SMTP Profile:**
For further details on custom SMTP profiles, navigate to the [SMTP Profiles Guide](https://docs.cyberawaresecurity.com/admin-portal/smtp-profiles) article.
**37.** We will choose a **Default Profile** and will enter a **spoofed** Email Address and Name as a sender (as long as the domain is registered and valid).
**38.** Before launching the campaign, we can test whether the emails can reach the target inbox. To do that, click on the **Send Test Email** button:
**39.** Fill the details required and click on **Send.**
**40.** Finally, select the **LAUNCH** button to **start** the email campaign.
**41.** Click on **Launch** to confirm your actions:
**42.** On the confirmation prompt that pops up, click **OK.**
**43.** To view **more than 10** entries in a single page, just click on the **drop-down list:**
**44.** Email has been sent as expected:
**45.** Click on the arrow prior to the user’s first name to view more details:
**46.** You can **reload** the results in real time using the **Refresh** button:
**47.** When we refresh the page, we see that the user has opened our phishing email:
**48.** Furthermore, there is a **timeline** of the campaign at the bottom of the page:
**49.** We also have the ability to **export** a **report** signifying the campaign’s current status in an **excel** format file. Click on the **Report** button:
**50.** You can generate either a **Results** or a **Raw Events** file:
**51.** Click on them in order to download:
**52.** Let’s open the **Results** file to see how it looks like:
**53.** On the other hand, the **Raw Events** is structured as follows:
**54.** The target has eventually **clicked** on a link from the campaign:
**55.** As a result, the platform managed to retrieve some information (version) in regard to the target’s system and browser:
**56.** Our target has also **submitted** some **data:**
**57.** If the **landing page** of the campaign has **capturing passwords enabled,** we will be able to view the details. We just have to click on the **View Details** button:
**58.** Moreover, if passwords were indeed captured, we could also choose to **Replay Credentials:**
**59.** A window will then pop up, prompting you to enter any site you want. The platform will then proceed to submit the captured data in order to check whether the credentials of that user can be used for **unauthorised** access.
**60.** If you have entered a link, click on **OK** to **proceed** or **Cancel** to **negate** the process.
**61.** At the end, the user has also opened the **attachment:**
**62.** Click on **View Details** to view the details that were retrieved:
**63.** Select the **Go Back** button to return to the Email Campaigns **default** page:
**64.** To **view** the **results** of a campaign just click on the **statistics** button:
**65.** You can always **pause** the campaign by clicking on the **Pause Campaign** button:
**66.** On the prompt that pops up, select **Pause Campaign** or **Cancel** accordingly:
**67.** On the next prompt, press **OK:**
**68.** You can **resume** the campaign by clicking on the **Resume Campaign** button:
**69.** Click on **Resume Campaign** to proceed:
**70.** Once again, select **OK** to finalise:
**71.** We could now demonstrate the **deletion** of the campaign, but since we can show this later on, let’s go ahead and click on **Complete Campaign** to end our campaign:
**72.** As usual, select **Complete Campaign** to end the process:
**73.** Click **OK** to proceed.
**74.** As we can see, our campaign is no longer part of the **Active Campaigns,** so let’s go over to the **Archived Campaigns:**
**75.** Finally, click on the **trash can** button to **delete** the campaign:
**76.** Confirm your action using **Delete.**
**77.** Click **OK** to end the process:
**78.** Otherwise, you may delete a campaign from within. You may do that through the **trash can** button:
# Training Campaigns
## Training Campaigns Guide
In this article, we explain the process of creating and distributing **Training Campaigns.** With these campaigns, organisations can train their employees through various lessons to enhance their cybersecurity awareness.
# Creating Training Campaigns
This section guides you through creating training campaigns to effectively train your users.
{% embed url="" %}
**1.** To create a **new** Training Campaign, click on the **New Campaign** button.
**2.** Enter a **Campaign Name:**
**3.** You can also enter a **Description:**
**4.** Enter the details and click on the **NEXT STEP** button to proceed to the **Training Content** phase:
Alternatively, we can navigate to the next step(s) by directly selecting them.
**5.** Click on the indicated button to choose any courses from the list:
**6.** For this example, we will add some courses:
**7.** Click on the **X** button beside these courses in order to **remove** them.
**8.** Let’s move on to the **Enroll Students** step:
**9.** Select the target group for the training campaign:
**10.** For demonstration purposes, we will add the **Accountants** group:
For this example, we will leave everything as it is and will proceed to the **Schedule** step:
**11.** From the following option, we can select the **Launch Date** for the campaign. In other words, the starting time where the training material will become available for the users.
If we leave the **start date blank,** the campaign will immediately roll out at launch and the material will be available for all users.
**12.** Furthermore, we can set the **end date** for the campaign. Training material will no longer be available afterwards.
If we leave the **end date blank,** the campaign will not expire, and the material will always be available for all users.
**13.** Select a **Timezone** for the campaign and proceed to **Review and Launch:**
**14.** At the final step, you may click on the **PREVIOUS** button if you are unsure about the campaign details:
**15.** Alternatively, click on the **LAUNCH** button to launch the campaign:
**16.** On the confirmation prompt that pops up, click **Launch** or **Cancel** accordingly:
**17.** Click **OK** to finalise the process.
**18.** As we can see, the **new** training campaign has been created!
On the left side of the window, we can see the campaign details, whereas on the right-hand side we can see all the content included in that training.
# Editing Training Campaigns
This section explains how to modify existing Training Campaigns to better fit your organisation's needs. Learn how to update content, adjust settings, and optimize your campaigns for improved employee engagement and learning outcomes
{% embed url="" %}
**1.** In case you want to change the end date of the training campaign, click on the **Edit end date** button.
**2.** For this example, we will extend the campaign for an additional hour:
**3.** Click on **Save** to apply the changes or **Cancel** to review this again.
**4.** Select **Save** and on the prompt that pops up click **OK** to proceed.
**5.** As we can see, the **End date** has been updated!
**6.** Let’s see how this looks from the user’s perspective:
**7.** You can start the campaign **immediately** by pressing the **Start Campaign** button:
**8.** On the window that pops up select **Start Campaign** to proceed.
**9.** Click **OK** to resume.
**10.** Statistics will become available under the **Students** section of the campaign, but in this case, we will have no results drawn since we will not interact with the training content for this demonstration.
**11.** You can always **pause** the campaign by clicking on the **Pause Campaign** button:
**12.** On the window that pops up select **Pause Campaign** to proceed.
**13.** Once again, click **OK** to continue.
**14.** You can **resume** the campaign by clicking on the **Resume Campaign** button:
**15.** On the confirmation window, click **Resume Campaign** to apply the changes:
**16.** Press **OK** to continue:
**17.** We could demonstrate the **deletion** of the campaign, but since we can show this later on, let’s go ahead and click on **Complete Campaign** to end our campaign:
**18.** As usual, select **Complete Campaign** to end the process:
**19.** Click **OK** to finalise:
**20.** Let’s **Go Back** to the **Training Campaigns:**
**21.** As we can see, our campaign is no longer part of the **Active Campaigns**, so let’s go over to the **Archived Campaigns:**
**22.** To view **more than 10** entries in a single page, just click on the **drop-down list:**
**23.** To **view** the **results** of a campaign just click on the **statistics** button:
**24.** Finally, click on the **trash** **can** button to **delete** the campaign:
**25.** Select **Delete** to confirm your action:
**26.** At the end, click **OK** on the confirmation prompt that pops up.
# USB Campaigns
## USB Campaigns Guide
In this article, we guide you on how to create and analyse a **USB Campaign.** These campaigns are necessary for showing us how employees react when finding an **unknown** USB drive.
**1.** To create a **new** USB Campaign, select the **New Campaign** button.
**2.** Enter the details required and click **CREATE CAMPAIGN** to create that campaign:
**3.** Let’s do an example:
**4.** On the confirmation that pops up, click **OK.**
You should get the following output:
**5.** Click on **Go Back** to return to the default page of the **USB Campaign.**
**6.** To **delete** the campaign, just click on the **trash can** button:
**7.** You should receive a message, essentially asking you to confirm your action. Click **Delete Campaign** or **Cancel** accordingly.
**8.** If you have selected **Delete Campaign,** you will then be prompted with a confirmation. Click **OK** to resume.
**9.** The following documents are **downloadable** and contain various **payloads** responsible for providing us the intended information upon the success of the campaign:
**10. Click** on any of them to download. In this case, we downloaded all 4 types of files:
**11.** Let’s take for example the **Word** file. **Right-click** on the file and select **Properties:**
**12.** On the properties, tick the **Unblock** box.
**13.** Click **OK** to apply the changes.
**14. Repeat** this exact procedure for the rest of the files (**Excel, PDF, PowerPoint**).
**15.** Go ahead and store either of these **4 files** in a **USB** so they are ready for distribution.
**16.** Now, it is finally time to **start** the campaign. To do that, click on the **Start Campaign** button.
**17.** On the prompt that pops up, select **Start Campaign** or **Cancel** accordingly.
**18.** Click **OK** to finalise.
**19.** You can view **more than 10 entries** in a single page by clicking on the **drop-down list:**
**20.** To **pause** the campaign, click on the **Pause Campaign** button.
**21.** Select **Pause Campaign** to confirm your actions or **Cancel** to step back.
**22.** Click **OK** to continue.
**23.** When returned to the campaign window, **resume** the campaign by clicking on the indicated option of the following screenshot:
**24.** Click on **Resume Campaign** to confirm or **Cancel** to negate the process.
**25.** Select **OK** in order to proceed.
**26.** Beginning with the **Word** file, let’s examine what should a user do in order to enable these payloads and what would the result be.
**27.** For the action to be received, the **target user** should **open** the file and select **Enable Content.**
**28.** The target user will now be prompted with this **ok.** message on their browser:
**29.** In case of the **Excel** file, the user should go ahead and **open** the file. When it opens up, they must select **Yes** on the following prompt:
**30.** Following up with clicking on the **Enable** **Content** button:
**31.** They will be prompted with this **ok.** message on their browser:
**32.** Alternatively, if they open the **PowerPoint** file, they must choose the **Enable content for this session** option and click **OK.**
**33.** They will be prompted with the following **Thank you** message on the **PowerPoint** file as well as the usual **ok.** message on the browser:
**34.** Finally, if they open the **PDF** file, they should press **OK** to allow the permissions:
**35.** Once again, they will be prompted with the **ok.** message on the browser:
**36. Assuming** that the user **opened** up and **interacted** with any of the files, we should expect a similar output to the following:
All the information is provided accordingly, but for security purposes, they are hidden in these images.
**37.** From the **Search recipient** button, we can denote a user that was identified as **prone** to the phishing attempt. In this way, she/he will be marked for future reporting and moderation under their respective organisation:
**38.** For demonstration purposes, we will mark **4 recipients** from our list. You can click on **Save** or **Cancel** accordingly.
**39.** We chose to save the changes:
**40.** After the reception of results, you can click on the **Complete Campaign** button to **terminate** the procedure.
**41.** On the pop-up, select **Complete Campaign** or **Cancel** accordingly.
**42.** Click **OK** to conclude:
**43.** As we can see from the details, the campaign has been **completed** as expected!
**44.** As always, you may delete the campaign if you wish. Just click on the **Delete Campaign** button.
**45.** Select **Delete Campaign** to finalise your action or **Cancel** to abort.
**46.** Click **OK** to resume.
**47.** Since we’ve completed the campaign, it is no longer active but rather **archived.**
**48.** Click on **Archived Campaigns** to view the campaign.
**49.** We can see that it exists as an archived campaign with a **Completed** status.
**50.** To **view** the results of any campaign (either active or archived), select the button shown in the following screenshot:
**51.** To **delete** any campaign (**either active or archived**), click on the **trash can** button.
**52.** On the confirmation prompt that pops up, select **Delete** to confirm or **Cancel** to retreat.
**53.** Click **OK** to continue.
# Recipients
## Recipients Guide
In this article, we demonstrate the creation, the monitoring and the maintenance of **Recipients** using the platform. Recipients are essentially employees (**simple users,** not admins) that have access only to the learning portal of their organisation in order to study the training material.
# Creating Recipients
In this article, we guide you through the process of creating Recipients within the platform. Recipients are employees who have access to the learning portal. You'll learn how to add new Recipients and ensure they are properly enrolled in the relevant Training Campaigns
{% embed url="" %}
**1.** Let’s create a **new** recipient. To do that, navigate through the **Add Recipient** option:
You will be prompted with the following pop up:
**2.** Let’s add the details for this example:
**3.** We clicked on **Save** and we were prompted with a confirmation window. Click **OK** to proceed.
**4.** The user has been created as expected!
**5.** Like earlier, this is an alternative place where you can **archive** your users. Click on the **trash can** symbol to proceed.
**6.** Go ahead and tap on **Archive:**
**7.** On the last pop up, click on **OK.**
**8.** Navigate to **Archived Recipients** to confirm the change:
**9.** To reactivate this user, click on the button shown in the following image:
**10.** When the prompt pops up, **Restore** the user:
**11.** Click **OK** to finalise:
**12.** The user is now restored!
**13.** When navigating to the **Recipients** section of the portal, we get the following output. Normally there wouldn’t be any recipients shown at the beginning, but we have created one for demonstration purposes.
**14.** You can view **more than 10 entries** in a single page by clicking on the indicated option of the following screenshot:
**15.** To view the recipient’s details, click on the **eye** button.
Before we continue with the rest, let’s summarise what is displayed on this specific user’s profile.
**16.** The **Recipient Details** window is split up to **three** parts. The **first upper** part shows different details and options that compose the user’s profile in addition to the risk scores:
**17.** The **second,** or else, **middle** part shows various details and statistics in regard to the overall training of the user.
**18.** Moreover, you can **change** the **format view** for the courses. That would be from **Table** to **List** and vice versa.
**19.** The **last** part of the recipient’s details window shows us whether any data breach has occurred in regad to that user. The platform crawls through the dark web and composes the following structured report with all of the retrieved information.
**20.** If you want to go back to the Recipients default page, click **Go Back:**
**21.** On the left-hand side, we can see the **Groups** in which the recipient belongs to. You can click on any of the groups appearing, so you can view them:
**22.** You should receive a similar output:
For further information regarding groups, click on this [link](https://docs.cyberawaresecurity.com/admin-portal/groups) so you can be redirected to the appropriate article.
# Editing Recipients
In this article, we demonstrate how to edit and maintain Recipients within the platform.
{% embed url="" %}
**1.** To edit a recipient, click on **Edit.**
**2.** Change the details you would like:
**3.** You can also set the recipient’s **organisation level.**
You can also **optionally** set the the recipient's department, division and location .
**4.** When everything is set, select **Save** to apply the changes. You can of course **Cancel** the changes.
**5.** Click **OK** on the prompt to proceed.
**6.** You can also change the recipient’s password. Just click on the **Change Password** option.
**7.** Enter the password **twice** and confirm it through the **Change Password** button. Alternatively, **Cancel** the change.
**8.** If you are sure about the change, choose **Add** or **Cancel** to reject it:
**9.** Click **OK** to continue.
**10.** To add the recipient to one or more groups, select the button shown in the following image:
**11.** Granted that you have **already** created a group, select the group of your choice:
**12.** Click **Add to group.**
**13.** Click **Add** to accept or **Cancel** to withdraw the process.
**14.** If you choose to add the recipient to the group, click **OK** to the prompt that pops up:
**15.** As we can see, the user has been added to the other group as well:
# Groups
## Groups Guide
In this article, we demonstrate the creation and maintenance of groups in the platform. **Groups** can be used to divide the recipients into their organisation’s respective department. Moreover, bulking people in a group will make it way easier to initiate a training or phishing campaign.
# Smart/Normal Groups
**Smart Groups** are dynamic and versatile. They are designed to provide a more automated and responsive approach to managing your users and their training needs. Here are the key features of Smart Groups:
* **Dynamic Enrollment:** Users can be automatically added or removed from Smart Groups based on predefined criteria or rules. This ensures that the group composition is always up-to-date without manual intervention.
* **Automated Training and Phishing Campaigns:** When there is an active training module or phishing campaign, new members of Smart Groups will automatically receive the relevant training materials and phishing emails. This ensures continuous and seamless security awareness and training efforts.
**Normal Groups**
**Normal Groups** offer a more static and manual approach to user management. They are straightforward and ideal for situations where group membership does not need to change frequently. Here are the key features of Normal Groups:
* **Manual Enrolment:** Users are added or removed from Normal Groups manually. This allows for precise control over group composition but requires manual updates to keep the group current.
* **Fixed Training and Phishing Campaigns:** Members of Normal Groups will receive training and phishing emails as assigned. However, unlike Smart Groups, new members will not automatically receive ongoing training or phishing campaigns unless they are manually added to the group.
* **Stable Group Membership:** Normal Groups maintain a stable composition, making them ideal for specific training programs or campaigns where group changes are minimal.
**Converting Between Group Types**
Our platform provides the flexibility to convert groups from one type to another:
* **Converting Smart to Normal:** If you find that a Smart Group's dynamic nature is no longer necessary, you can convert it to a Normal Group. This will fix the group composition and stop automatic updates.
* **Converting Normal to Smart:** If you need a more adaptive and responsive group, you can convert a Normal Group to a Smart Group. This will enable automatic user updates and ensure that new members receive ongoing training and phishing campaigns.
# Smart Groups
## Groups Guide
In this article, we explore the creation and management of Smart Groups within the platform. Smart Groups allow you to automate the organization of recipients based on dynamic criteria, making it easier to target specific audiences for training or phishing campaigns
{% embed url="" %}
**1.** To create a new group for recipients, click on the **New Group** button.
2. Add the group name and description then select **smart group** from group type and click **NEXT STEP** to proceed.
**3.** If you would like to return to the default page of **Groups,** just click on **Go Back.**
**4.** At the second stage of the process that is recipient related, you have the option to create recipients. This is **optional,** so you can proceed to the **NEXT STEP** accordingly.
**5.** If you wish to create users, you can do it manually by adding their details (ex. First Name, Email, etc.):
**6.** You can also select the position of that recipient through the **drop-down list** and click **Add** to finally add the draft user for review.
**7.** Alternatively, for larger groups of known people, you can **mass add** users on the platform by importing **CSV** files.
**8.** The structure of the CSV file should be specific so the platform can retrieve the information properly. To guide you, there is a CSV file available for download that shows the proper format for use:
**9.** Inserting users using the **Bulk Import** button:
For this instance, we are using a custom template:
**10.** As we can see, our users have been successfully added for review:
**11.** In the prompt that appears, select **Cancel** if you would like to review again. Otherwise, select **Create** to create the group as expected.
In case that you haven’t entered any recipients during the **Recipients** phase, this will create an **empty** group. You may use this method when creating [Email Campaigns](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns).
**12.** Click **OK** on the last prompt.
**13.** Let’s do a demonstration:
**14.** Finally, our group has been created along with the users!
**15.** Now, let’s enter a user **manually** for demonstration:
**16.** We can click on the **trash can** icon to **delete** that user:
**17.** Instead, we will continue:
**18.** As expected, the new **Group** called **DevOps** now exists and it includes the user we have created!
**19.** You can **edit** the group type from smart to normal and vise versa through the **Edit** button :
**20.** To add an existing recipient to the group, select the **Add Existing Recipient** button:
**21.** Pick the recipient of your choice and click **Add** to confirm, or **Cancel** to negate the procedure:
**22.** On the confirmation that pops up, just click **OK.**
**23.** Moreover, you can add a new recipient in the group through the **Add New Recipient** button:
**24.** Add the required details and select the organisation level for that recipient from the drop-down list.
**25.** Click **Save** to store the new recipient, or press **Cancel** to return to the previous window.
**26.** Alternatively, for larger groups of known people, you can **mass add** users on the platform by importing **CSV** files using the add bulk recipients.
**27.** To view the user of a group, click on the **eye** button next to the record details:
To learn more about recipients, please visit the following [link](https://docs.cyberawaresecurity.com/admin-portal/recipients).
**28.** In case you wish to **delete** a user from a group, click on the **trash can** button.
**29.** To confirm the action, click on **Remove target.** Otherwise, select **Cancel.**
**30.** When removing the target recipient, a confirmation prompt pops up. Click **OK** to resume.
**31.** Another option is to **Go Back** to the default page of **Groups,** to view the current groups.
**32.** To return to the “view” page of your group, click on the **eye** button.
**33.** Alternatively, to **edit** the group itself, click on the **pencil** symbol:
**34.** You can always **delete** a group from the list by selecting the **trash can** button.
**35.** Just confirm your action with **Delete** or select **Cancel** to reject:
**36.** On the confirmation prompt, click **OK** to continue exploring the portal.
# Normal Groups
## Groups Guide
In this article, we cover the creation and management of Normal Groups within the platform. Normal Groups allow you to manually organize recipients into specific categories or departments, facilitating the management of training and phishing campaigns.
**1.** To create a new group for recipients, click on the **New Group** button.
2. Add the group name and description then select **normal group** from group type and click **NEXT STEP** to proceed.
**3.** If you would like to return to the default page of **Groups,** just click on **Go Back.**
**4.** At the second stage of the process that is recipient related, you have the chance to create recipients. This is **optional,** so you can proceed to the **NEXT STEP** accordingly.
**5.** If you wish to create users, you can do it manually by adding their details (ex. First Name, Email, etc.):
**6.** You can also select the position of that recipient through the **drop-down list** and click **Add** to finally add the draft user for review.
**7.** Alternatively, for larger groups of known people, you can **mass add** users on the platform by importing **CSV** files.
**8.** The structure of the CSV file should be specific so the platform can retrieve the information properly. To guide you, there is a csv file available for download that shows the proper format for use:
**9.** Inserting users using the **Bulk Import** button:
For this instance, we are using a custom template:
**10.** As we can see, our users have been successfully added for review: select **NEXT STEP** to proceed to the **Review** stage
**11.** If you are happy with everything, just click on **CREATE** to finalise.
**12.** In the prompt that appears, select **Cancel** if you would like to review again. Otherwise, select **Create** to create the group as expected.
In case that you haven’t entered any recipients during the **Recipients** phase, this will create an **empty** group. You may use this method when creating [Email Campaigns](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns).
**13.** Click **OK** on the last prompt.
**14.** Finally, our group has been created along with the users!
**15.** Now, let’s enter a user **manually** for demonstration:
**16.** We can click on the **trash can** icon to **delete** that user:
**17.** Instead, we will continue:
**18.** As expected, the new **Group** called **DevOps** now exists and it includes the user we have created!
**19.** You can **edit** the group type from smart to normal and vise versa through the **Edit** button
**20.** To add an existing recipient to the group, select the **Add Existing Recipient** button:
**21.** Pick the recipient of your choice and click **Add** to confirm, or **Cancel** to negate the procedure:
**22.** On the confirmation that pops up, just click **OK.**
**23.** Moreover, you can add a new recipient in the group through the **Add New Recipient** button:
**24.** Add the required details and select the organisation level for that recipient from the drop-down list.
**25.** Click **Save** to store the new recipient, or press **Cancel** to return to the previous window.
**26.** Alternatively, for larger groups of known people, you can **mass add** users on the platform by importing **CSV** files using the add bulk recipients.
**27.** To view the user of a group, click on the **eye** button next to the record details:
To learn more about recipients, please visit the following [link](https://docs.cyberawaresecurity.com/admin-portal/recipients).
**28.** In case you wish to **delete** a user from a group, click on the **trash can** button.
**29.** To confirm the action, click on **Remove target.** Otherwise, select **Cancel.**
**30.** When removing the target recipient, a confirmation prompt pops up. Click **OK** to resume.
**31.** Another option is to **Go Back** to the default page of **Groups,** to view the current groups.
**32.** To return to the “view” page of your group, click on the **eye** button.
**33.** Alternatively, to **edit** the group itself, click on the **pencil** symbol:
**33.** You can always **delete** a group from the list by selecting the **trash can** button.
**34.** Just confirm your action with **Delete** or select **Cancel** to reject:
**35.** On the confirmation prompt, click **OK** to continue exploring the portal.
# Email Templates
## Email Templates Guide
In this article, we explain the process of creating and editing **Email Templates.** These templates can be used as part of various phishing campaigns aiming to evaluate the potential risk within an organisation.
# Creating Email Templates
This article guides you through creating and customizing email templates. Learn how to start a new template, use text formatting options, add images and multimedia, and apply dynamic variables for personalization. Follow the steps to finalize and save your template.
{% embed url="" %}
**1.** To create a **new** Email Template, click on the **New Template** button.
You should get the following output:
**2.** Enter the details required such as the template name and move to the **Template** phase in order to create it.
**14.** You can start by first adding the email subject and then type the email in the text box:
Moreover, you can edit your page with some options provided on the menu above.
**3.** The first three options are standard text formatting options: **B** for **bold, i** for **Italic** and **U** for **underline.**
**4.** When pressing the **A** button, more text options appear regarding formatting.
**5.** The next three options, are alignment related. **Left, centre** and **right** respectively:
**6.** The next symbol (also shown below), provides more paragraph options.
**7.** Click on the “image” button to upload an image:
**8.** You can insert an image either from a **file location** or by **URL:**
**9.** The “plus” option of the menu, provides a diversity of things to your text, such as **video, table, etc.**
**10.** Some other options exist on the **right side** of the menu. The first one that looks like your usual **settings** symbol, provides a range of **variables.** These variables help in retrieving and applying **real time data** during the campaign, to make the email look credible.
**11.** For example, for a recipient called **John Doe,** the variable named **{{.FirstName}}** will retrieve the word John, so whenever the campaign is sent, it will use that user’s first name to make it believable:
**12.** The next option with the two arrows (**< >**) provides a **code view** of our page where you can **add** or **edit** the **html code** as you wish:
**13.** From the last button, you may **redo** or **undo** any of your actions on the page:
**14.** Enter the details you would like and select the **Create Template** button to create that template.
**15.**A confirmation prompt should then pop up. Click **OK** to finalise.
**16.** Let’s do an example:
**17.** As we can see, the new email template has been created!
# Editing Email Templates
This article provides a step-by-step guide on managing email templates. Learn how to view, copy, and edit existing templates, including changing names, categories, and subjects. Discover how to preview changes, return to previous steps, and delete templates, with clear instructions on handling each action.
{% embed url="" %}
**1.** To view the existing **System Templates,** click on the indicated option:
You should get the following output:
**2.** To view **more than 10** entries in a single page, just click on the **drop-down list:**
**3.** You can **filter** the templates, based on the category:
**4.** To **view** a template, click on its **eye** button. It will open the template in a new tab on the browser.
This is essentially how the targets will view these templates via email:
**5.** To **copy** a template, click on the button shown below:
You should get the following output:
**6.** You can change the **Email Template Name** to one of your likes.
**7.** Additionally, you can set a different **category** for that template.
**8.** Click on **NEXT STEP** to proceed to the **Template** phase:
**9.** On the new prompt, you can edit the template as you wish. For example, you could change the **Email Subject:**
**10.** If you want to return to the **General Information** phase, there is a **PREVIOUS** button found at the bottom of the page.
Please note that in doing so, the Email Subject will be **erased,** and you will have to enter it again.
**11.** We can also view a **Preview** of the template on the right-hand side.
The rest of the details will be explained in the following steps, where we will be **creating** a new email template (**since the process is the same**).
**12.** You can **edit** an existing email template. To do that, click on the **pencil** symbol:
**13.** Click on **Go Back** to return to the default page:
**14.** Finally, to **delete** a page you have created, just click on the **trash can** button:
**15.** You should receive a message, essentially asking you to confirm your action. Click **Delete** or **Cancel** accordingly.
**16** If you’ve selected **Delete,** you will then be prompted with a confirmation. Click **OK** to resume.
# Landing Pages
## Landing Pages Guide
In this article, we explain the process of creating and editing **Landing Pages.** These pages can be used to execute different phishing campaigns in order to evaluate the potential risk of an organisation.
# Creating Landing Pages
This article provides a comprehensive guide to creating and managing landing pages. Learn how to start a new landing page, import web pages, and customize your content using various formatting tools. Discover how to add images, multimedia, and dynamic variables, as well as preview, edit, or delete pages. Follow these steps to efficiently create and manage your landing pages.
{% embed url="" %}
**1.** To create a new **Landing Page,** click on the **New Landing Page** button.
You should get the following output:
**2.** Enter the details required such as the template name and move to the **Template** phase in order to edit.
**3.** Click on the **Import Site** so you can directly import any web page you would like.
**4.** Enter the **URL** and click on **Import.** You can always **Cancel** the process:
**5.** The following URL **** is used as an example:
**6.** This would be the output:
**7.** Alternatively, you can start by typing something in the text box instead of directly importing a site on the platform:
In either case, you can edit your page with some options provided on the menu above.
**8.** The first three options are standard text formatting options: **B** for **bold, i** for **Italic** and **U** for **underline.**
**9.** When pressing the **A** button, more text options appear regarding formatting.
**10.** The next three options, are alignment related. **Left, centre** and **right** respectively:
**11.** The next symbol (also shown below), provides more paragraph options.
**12.** Click on the “image” button to upload an image:
**13.** You can insert an image either from a **file location** or by **URL:**
**14.** The “plus” option of the menu, provides a diversity of things to your text, such as **video, table, etc.**
**15.** Some other options exist on the **right side** of the menu. The first one that looks like your usual **settings** symbol, provides a range of **variables.** These variables help in retrieving and applying **real time data** during the campaign, to make the page look credible.
**16.** For example, for a recipient called **John Doe,** the variable named **{{.FirstName}}** will retrieve the word John, so whenever the campaign is sent, it will use that user’s first name to make it believable:
**17.** The next option with the two arrows (**< >**) provides a **code view** of our page where you can **add** or **edit** the **html code** as you wish:
**18.** From the last button, you may **redo** or **undo** any of your actions on the page:
**19.** Enter the details you would like and select the **Create Template** button to create that page.
**20.** A confirmation prompt should then pop up. Click **OK** to finalise.
**21.** Let’s do an example:
**22.** As we can see, the new landing page has been created!
# Editing Landing Pages
This article explains how to manage and modify existing landing pages. Learn how to view and filter system pages, copy and rename pages, and adjust settings such as categories and data capture options. Discover how to enable or disable data capture, set redirect URLs, and preview your changes. Follow these steps to effectively edit and update your landing pages.
{% embed url="" %}
**1.** To view the existing **System Pages,** click on the indicated option:
You should get the following output:
**2.** To view **more than 10** entries in a single page, just click on the **drop-down list:**
**3.** You can **filter** the pages, based on the category:
**4.** To **view** a page, click on its **eye** button. It will open the template in a new tab on the browser.
This is essentially how the targets will view these templates via email:
**5.** To **copy** a page, click on the button shown below:
You should get the following output:
**6.** You can change the **Landing Page Name** to one of your likes.
**7.** Additionally, you can set a different **category** for that page.
**8.** To enable or disable the capture of submitted data, click on the following button. Submitted data will provide information regarding users’ activity that clicked on a phishing link:
**9.** If we enable the button showing in the following image, we will capture any password entered by users.
**10.** You can enter a **Redirect URL,** so when users submit their credentials, they are redirected to that specific page.
**11.** Click on **NEXT STEP** to proceed to the **Template** phase:
**12.** If you want to return to the **General Information** phase, there is a **PREVIOUS** button found at the bottom of the page.
**13.** We can also view a **Preview** of the landing page on the right-hand side.
Then you can change whatever you wish on the template based on your organisation needs.
# Course Catalogue
## Course Catalogue Guide
In this article, we help you navigate through the **Course Catalogue.** You can combine courses you like into a **training campaign** and distribute them throughout the whole personnel to raise your organisation’s level of cybersecurity awareness.
{% embed url="" %}
**1.** Navigate to **Course Catalogue** to view the available courses:
**2.** You may search for the course you are looking for through the **search,** filter the output based on the **category,** or based on **language:**
**3.** For example, when filtering the output based on **Essentials** category and **English** language**,** this is the result we get:
**4.** You can view more than 10 entries in a single page by clicking on the **drop-down list:**
**5.** Moreover, you can modify the way the courses are listed by clicking on the button on the right upper corner:
**6.** Finally, let’s click on the **Lesson 1-L1: Identifying the Need for Security** course to read further details about it. The course details will open on a new web browser window showing the course card. You can click on the **Continue** button to see the course contents.
# Course Editor
## **Course Editor Guide:**
In this article, we explain the functionalities of the **Course Editor.** This builder allows organisations to create their own courses which can be used as part of Training Campaigns to enhance the security awareness of their personnel.
{% embed url="" %}
**1.** Navigate to **Course Editor** and click on the **Add Course** option:
You will be prompted with the following window:
**2.** Let’s enter some details to proceed such as the name and description as they are mandatory:
**3.** Click on **Create:**
**4.** On the confirmation prompt, select **Create** or **Cancel** accordingly:
**5.** If you have selected to **Create,** you will be displayed with a final prompt, just click **OK** to continue and a new web browser window will open to add content on your new course:
**6.** To start setting up a course with material, click on the **Add an activity or resource** option or the **Add** **topic** button(If you do not see such options click on the upper right corner the option Turn editing on):
**7**. Once you click on Add an activity or resource you will be presented with three options, to add a certificate, add interactive content and add SCORM package.
**8**. Interactive content is feasible using an add-on called H5P. On how to add such content follow the below link.\
# Login Info & Security
## Login Info & Security
In this segment, we demonstrate how a user of the **admin** portal can manage their login security through the **Login Info & Security.** From this section, we can **change** our **password** and **enable** the **two-factor authentication.**
{% embed url="" %}
# Login Details Guide
## Login Details Guide
In this article, we demonstrate how a user of the **admin** portal can **change** their **password** through the **Login Info & Security** section.
**1.** Navigate to **Login Info & Security:**
**2.** To replace the old password with a **new** one, **confirm** your current password and enter **twice** the new password you would like to use. Click on **Save** to save the changes.
**3.** As we can see, the settings have been updated successfully!
# Two-Factor Authentication Guide
## Two-Factor Authentication Guide
In this article, we demonstrate how a user of the **admin** portal can **secure** their account through the **Login Info & Security** section by **enabling** the **two-factor authentication** option.
**1.** Navigate to **Login Info & Security:**
**2.** Go ahead and select the **Two-Factor Authentication** option:
You should get the following output:
**3.** As shown below, you can **Download Codes** to save the generated recovery codes for that profile in a **txt** file format:
**4.** To proceed, you will need to download the **Authenticator** application via **Google Play** or the **App Store:**
**5.** From the now installed **Google Authenticator,** select to **Scan a QR code** and **hover your smartphone over** the generated **QR code** found on your computer screen to complete the **scan** process.
**6.** A **6-digit code** will be generated in your application. Enter that code into the indicated **text box** and click on **Verify:**
**7.** As expected, the code has been **verified!**
**8.** Select the **Complete Setup** button to conclude the process:
**9.** On the confirmation prompt that pops up, select to **Confirm** or **Cancel** accordingly.
**10.** If you’ve confirmed the action, click **OK** to proceed:
**11.** Now that we’ve set up the 2-factor authentication, let’s put things to the test. **Sign out** or **navigate** to your **cyberawaresecurity** portal:
**12.** From the **login page,** enter your **credentials** and press on the **Sign in** button:
You will be prompted to enter a two-factor authentication code:
**13.** Once again, enter the code generated in your application and click on **Confirm:**
**14.** To **disable** the **Two-Factor Authentication** settings, navigate back to the **Login Info & Security** section and click on the available **Disable Two-Factor Authentication** option:
**15.** Select **Disable** or **Cancel** accordingly:
**16.** On the last prompt, click **OK** to finalise.
# Support Access
## Support Access Guide
In this article, we provide a few simple steps to **enable** or **disable** the feature called **Support Access.** You will find this utility very useful in case you face any **technical difficulties** while using our platform. By enabling it, you essentially grant **DefensityOne authorisation** to access your portal and an agent will be able to **confirm** and **fix** any **issues.** To make this procedure as efficient as possible, please contact us at stating the issue, so we can directly target it and get back to you with an update.
**1.** Navigate to **Login Info & Security:**
**2.** Go ahead and select the **Support Access** option:
**3.** To **temporarily** allow DefensityOne access to your workspace, click on the Grant Access button:
**4.** From the prompt that pops up, we can see that the duration for such access will last for **7 days.**
**5.** If you wish to proceed, press on the **Confirm** button:
**6.** Select **Confirm** or **Cancel** accordingly:
**7.** If you’ve confirmed the action, click **OK** to proceed.
**8.** As we can see, remote access has been successfully granted!
**9.** You can **manually disable** remote access from your portal using the following indicated button:
**10.** On the confirmation prompt that pops up, select **Disable** or **Cancel** accordingly.
**11.** Once again, click **OK** to finalise.
# Session Timeout
## Session Timeout Guide
In this article, we demonstrate how an **admin** of the **CYBERAWARE SECURITY** platform can **secure** further their organisation by setting up a **Session Timeout** for the **users** (administrators) and **students** (recipients) through the **Login Info & Security** section. It is important for all users to spend the least amount of time exposed on the Internet while inactive!
**1.** Navigate to **Login Info & Security:**
**2.** Go ahead and select the **Session Timeout** option:
You should get the following output:
**3.** The **User session** essentially refers to the **admins’ timeout** session policy. In general, we would suggest that you set the ideal time of **15 minutes** for **more security.**
Although many options are available, the **minimum** time to set is **5 minutes** while the **maximum** possible is **24 hours.**
**4.** As expected, you can change the **Students session** timer to apply the corresponding settings on the **recipients’** portal.
**5.** Click on **Save** to apply your changes:
Whenever we set a session timeout, there’s the time window of said timer where if a user would **not interact** with the platform in any way, they will be **logged out automatically.**
**6.** From the confirmation prompt that pops up, click on **OK** to proceed as expected:
# User Management
## User Management Guide
In this article, we explain the process of **User Management** for admins. If you are assigned the **admin** role, you will be able to **create** **and** **edit** various user profiles (that have the role of a simple user or admin) that have access to the admin portal:
{% embed url="" %}
**1.** You can view **more than 10 entries** in a single page by clicking on the drop-down list:
**2.** To **edit** an **existing** user, press on the **pencil** symbol:
You should get the following output:
**3.** Make the changes you would like and click on **Save changes** or **Close** accordingly:
**4.** As we can see, the user administrator has been updated successfully!
**5.** To create a **new** user, press on the indicated button shown in the following image:
You should get the following window:
**6.** Fill the details for the user you would like to create.
**7.** Furthermore, you can alter the role for that user. To do that, click on the button shown below:
That role would be either **User** or **Admin:**
**8.** At the end, please do not forget to select **Create** to create the user or **Close** if you wish to exit without creating the user.
**9.** With that being said, let’s make an example:
**10.** As we can see from the following screenshot, the new user has been registered successfully!
**11.** To **archive** an **existing** user, click on the **trash can** button:
**12.** You should receive a message, essentially asking you to confirm your action. Click **Archive** or **Cancel** accordingly.
**13.** On the final prompt, click **OK.**
# Active Users
# Phishing Admin
## **Phishing Admin User Guide:**
In this article, we exhibit the capabilities of the **Phishing Admin** user role. Guidelines for **creating** such user, as well as **comparison** between the roles are provided. This role can be managed through the **User Management** section of the CYBERAWARE SECURITY and can be given to personnel that should only be able to create Email Campaigns from the admin portal.
**1.** Navigate to **User Management:**
**2.** Go ahead and create a **New User:**
You should get the following output:
**3.** Enter the details for the user you would like to create and click on the **drop-down** list as shown bellow:
**4.** Choose **Phishing Admin:**
**5.** Select the **Create** button to create that user:
**6.** As we can see, the **Phishing Admin** user has been registered successfully!
**7.** Let’s view this from the other perspective comparison Examples to demonstrate:
**8.** Following with a few more examples of changes. Login Info and this.
**9.** This user role can create Groups and Recipients, create Email Templates and Landing pages, schedule/create Phishing and USB Campaigns and export Reports.
# Training Admin
## **Training Admin User Guide:**
In this article, we exhibit the capabilities of the **Training Admin** user role. Guidelines for **creating** such user, as well as **comparison** between the roles are provided. This role can be managed through the **User Management** section of the CYBERAWARE SECURITY and can be given to personnel that should only be able to create training campaigns from the admin portal.
**1.** Navigate to **User Management:**
**2.** Go ahead and create a **New User:**
You should get the following output:
**3.** Enter the details for the user you would like to create and click on the **drop-down** list as shown bellow:
**4.** Choose **Training Admin:**
**5.** Select the **Create** button to create that user:
**6.** As we can see, the **Training Admin** user has been created successfully!
**7.** Let’s view this from the other perspective comparison Examples to demonstrate:
**8.** Following with a few more examples of changes. Login Info and this.
**9**. This user role can create Groups and Recipients, go through the Course Catalogue, create courses, schedule/create Training Campaigns and export Reports.
# View Only User
## View Only User Guide
In this article, we exhibit the capabilities of the **View Only** user role. Guidelines for **creating** such user, as well as **comparison** between the roles are provided. This role can be managed through the **User Management** section of the CYBERAWARE SECURITY and can be given to personnel that should only be able to view and draw results from the admin portal.
**1.** Navigate to [User Management](https://docs.cyberawaresecurity.com/admin-portal/user-management):
**2.** Go ahead and create a **New User:**
You should get the following output:
**3.** Enter the details for the user you would like to create and click on the **drop-down** list to select his/her **Role:**
Each role provides **different capabilities** in the platform and should be distributed proportionally in accordance with their duties.
**4.** In this case, we should select **View Only:**
**5.** Click on **Create** to finally create that user:
**6.** As we can see, the **View Only** user has been registered successfully!
**7.** To grasp the role differences, let’s view this from both perspectives. For this example, we will be comparing the **view only** and **admin** users’ point of view of the platform:
We can distinguish that both **ADMIN** and **STUDENT PORTAL** sections are **not available** for the **view only** user.
**8.** Following with a few more examples showcasing the differences. In [Login Info & Security](https://docs.cyberawaresecurity.com/admin-portal/login-info-and-security) section:
**Support Access** button does **not exist.**
**9.** When it comes to [Email Campaigns](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns):
**Delete** and **New Campaign** button do **not exist.**
**10.** When visiting a **recipient profile,** all **functionality** buttons are **hidden:**
To learn more about recipients, please visiting the following [link](https://docs.cyberawaresecurity.com/admin-portal/recipients).
**11.** Finally, **creating, editing,** and **deleting** options for [Groups](https://docs.cyberawaresecurity.com/admin-portal/groups) are **unavailable:**
# Archived Users
## **Archived Users Guide**
In this article, we explain the process of restoring archived users. If you are assigned the **admin** role, you will be able to restore a user that has been archived.
1. To view all archived users, visit [User Management](/admin-portal/user-management) from the menu on the left and then click on Archived Users.
2. Then you will see a list with all Archived Users. From the list of the Archived Users, you can click on the restore icon to restore the user you wish. Just like the screenshot below click on the restore icon.
3. A pop-up window will open asking you whether you wish to restore the user or cancel the operation.
4. Click the restore button and a new pop window will be shown, informing you that the user has been successfully restored.
5. The restored user can now be found under the Active Users tab.
# Organisation Settings
## Organisation Settings Guide
In this article, we explain the process of adding organisation fields such as Departments, Divisions and Locations. The admin has also the ability to setup custom fields which can be text boxes or dropdown boxes. By adding such organisation fields you may then specify on Recipients to which Department they belong, which Division and to what Location. Such fields are also available on Phishing Reports to filter out reports based on Location, Department, Division and based on the values of the Custom Fields.
{% embed url="" %}
1. From the main menu navigate to Organisation Settings.
2. On the Organisation Settings page you can create Departments, Divisions, Locations and Custom Fields.
3. The above screenshot shows some Departments that have already been created. To create a new Department, click on the button named New Department and complete the Department name and Description. The Description field is optional.
4. Click the Save button to create the Department or the Close button to cancel the operation. You can follow the same steps to create Divisions and Locations.
5. You can also create Custom Fields which can be either a text box or a dropdown box.
6. Once the Custom Field has been defined, click the Save button to create it, or the Close button to cancel the operation.
# SMTP Profiles
## SMTP Profiles Guide
In this article, we explain how to **create** custom sending **SMTP Profiles** as an **admin** on the admin portal. **Custom** SMTP profiles provide you the ability to relay student notifications and phishing emails from them. This eliminates the need to whitelist our SMTP (**IP** and **hostname**) server and is especially beneficial for organisations that have strict security mechanisms in place.
{% embed url="" %}
**1.** To create a **new** **SMTP** profile, select the **New Profile** button.
You should get the following prompt:
**2.** Enter the details required and select **Save Profile** or **Cancel** to negate the process.
**3.** When creating a custom SMTP profile, we can test whether the emails from that profile are able to reach the target’s inbox. To do that, click on the **Send Test Email** button:
**4.** Fill the details required and click on **Send.**
**5.** Click on the **drop-down** list to view more than 10 entries in a single page:
**6.** Let’s make an example:
The details shown above are for demonstration purposes. You should add your own configuration details for this to work.
**7.** You can use alternative ports like **25, 993, etc.**
**8.** Make sure the **Ignore Certificate Errors** option is **ticked.**
**9.** As we can see, the new SMTP profile called **cyberaware** has been added successfully!
**10.** Generally, you can edit an existing profile by clicking on the **pencil** symbol:
**11.** Change the details you would like and click on **Save Profile.**
**12.** Changes were applied.
**13.** To **copy** an existing profile, select the button shown in the following image:
**14.** The copied profile prompt should pop up:
**15.** Change the details accordingly and select the **Save Profile** button.
**16.** The **copied** profile has been added as expected:
**17.** Alternatively, to **delete** a stored SMTP profile, click on the **trash can** button:
**18.** You should receive a message, essentially asking you to confirm your action. Click **Delete** or **Cancel** accordingly:
**19.** Click **OK** to finalise.
# Categories
## Categories Guide
In this article, we explain the process of adding **Categories** as an **admin** on the admin portal. You can create **custom** categories to use for your custom email templates and landing pages. This will help cover a wider range of categories when designating your templates upon the creation process.
{% embed url="" %}
**1.** To create a **new** category, click on the button shown in the following screenshot:
The following window should then appear:
You can now fill the details for the category you would like to create.
**2.** Go ahead and click on the **Save changes** button to save your changes or the **Close** button if you prefer to exit the window without saving any changes.
**3.** Following with an example:
**4.** From the following image, we can see that the new category was created successfully!
**5.** When finished, you can **edit** an **existing** category, by pressing on the **pencil** button:
**6.** From the pop-up prompt, you can edit any of the details and press on **Save changes** or **Close** to avoid the changes.
**7.** Finally, if you would like to **delete** an existing category, you should click on the **trash can** symbol.
**8.** You should receive a message, essentially asking you to confirm your action. Click **Delete** or **Cancel** accordingly.
**9.** If you chose to delete the category, click **OK** on the final prompt:
**10.** The category has been removed as expected:
**11.** Click on the **System Categories** to view the system categories which are available for use:
**12.** You can view **more than 10 entries** in a single page by clicking on the indicated option of the following screenshot:
# Authorised Domains
## Authorised Domains Guide
In this article, we explain the process of adding **Authorised Domains** as an **admin** on the admin portal. This will allow you to issue training and phishing campaigns for your users, using email addresses that derive from such domains.
**Prerequisites:**
Before adding a domain, ensure that the requirements below are met:
* You own the domain.
* You can whitelist emails sent to the domain.
* You can add a TXT record for the authorised domain to the DNS server.
**1.** Click on the **drop-down** list to view more than 10 entries in a single page:
**2.** Click on the following button to create a **new** authorised domain:
You should expect the following output:
**3.** Fill the details required and select **Close** or **Save changes:**
**4.** For this example, we will be using a domain called **example.com.**
You should receive a similar prompt with a unique txt record for verification:
All the information is provided accordingly, but for security purposes, they are hidden in these images.
**5.** As mentioned in the image above, create a **txt record** for your corresponding domain in your **DNS provider.**
**6.** To do that, open a new window and access your **DNS.** From there, select the **Add Record** and set the **Record Type** to **TXT Record:**
**7.** Then, paste **your unique txt** record in the text box:
**8.** Click **Add Record** to save it or **Cancel** to step back:
**9.** If you have added the record, return to your **Verify domain** prompt in the platform:
**10.** If you choose to **Close,** the process will finalise without verifying the domain and you will have to repeat the process of verification again:
**11.** From there, you can also edit the soon-to-be authorised domain by clicking on the **pencil** symbol:
**12.** Alternatively, if you select **Verify Domain,** a confirmation window will appear. Click **OK** to proceed.
**13.** As we can see, the domain has been authorised as requested!
**14.** You can always delete a domain. To do so, click on the **trash can** button:
**15.** Select **Delete** to confirm your action or **Cancel** to maintain the domain.
**16.** If you’ve chosen to delete the domain, a confirmation prompt should pop up. Select **OK** to finalise!
# Plugins
# Microsoft 365 Phishing Reporter
## Microsoft 365 Phishing Reporter Guide
In this article, we demonstrate the deployment of the **Phishing Reporter** for an **Office 365 admin** account, as well as the client side when reporting an email. Admins of the **CYBERAWARE SECURITY** portal can also observe the changes of reporting through **Email Campaign** results and their generated **Reports.**
**1.** Navigate to **Plugins:**
**2.** Let’s manage the **Plugin Configuration** by clicking on it:
**3.** Enter an email address in the first box. That mailbox will be used to receive all recipient reported emails that were not part of the [Email Campaigns](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns). Essentially, it will **filter** out **scheduled** phishing campaigns intended for **training/testing purposes,** to distinguish emails that could potentially be real phishing attempts.
As stated, you may add **multiple addresses** separated by a comma.
**4.** Here, you can specify the behaviour of the plugin after an email has been submitted as a phishing attempt:
**5.** For this example, we are choosing to automatically move the reported email to the **spam/junk folder** of the **Outlook.**
**6. Tick** the following box to prompt recipients to provide a reason for reporting an email:
**7.** If you are satisfied with the configuration, click on **Save changes:**
**8.** As we can see, the settings have been updated!
**9.** Once the configuration process is done, let’s actually **install** the required reporter tool. Click on the following link to access the **Integrated Apps** section under your **Microsoft 365 admin centre.**
You should get the following output:
**10.** As guided by the installation process, select the option to **Upload custom apps:**
**11.** Choose the option **Provide link to manifest file:**
**12.** Copy the link provided under the **2nd installation step** and paste it in the text box for validation:
**13.** Click on **Validate.**
**14.** As we can see, the manifest file has been **validated** as expected!
**15.** You can now select **Next** to proceed:
**16.** If this is a **testing deployment,** you should select the button indicated below:
For this instance, we will not be selecting that option.
**17.** To enable the phishing reporter plugin for all users of the platform, select the **Entire organization** option. Otherwise, you can specify either **yourself** or the **users/groups** that should have this feature available.
Note that if you’ve selected the **entire organisation,** there will be needed **approximately 12 hours** for **Outlook’s tools** to **update** and **Phishing Reporter** to appear as expected.
**18.** Press on the **Next** button to proceed.
**19.** Once again, click on **Next.** You will reach the **Finish** step:
**20.** Finally, select **Finish deployment** to conclude the process:
**21.** As we can see, the deployment is completed!
**22.** Let’s have a look from the Outlook’s side of things. In the **Home** tab, you will find that a **Report a phishing mail tool** was eventually added. Click on the specified button:
**23.** When we click on the **Report a phishing mail** button, we get the following option:
**24.** Click on **Send report** to **finalise.** In this instance, we will report this email using the **default reason** called **Suspicious content**. As always, a recipient may select the appropriate reason for their case. When selecting the **Other reason** option, a user will be asked to provide a description of the issue as well.
**25.** As we can see, the report has been submitted as expected!
**26.** We can also observe that the email has been moved into the **Junk Email** folder:
**27.** When clicking on it, we can view the following:
**28.** If the email reported was part of a phishing campaign, reporting such email will trigger an update on the results of said campaign, indicating that the email has been reported:
**29.** On the other hand, if the email was not part of a campaign and has been reported, the email address that was added during the configuration step will receive an email containing an **eml** file so it can be **viewed/analysed** later. If the recipient has added a **description** during the reporting procedure, it will also be included:
# GSuite Phishing Reporter
GSuite Phishing Reporter
In this article, we demonstrate the deployment of the Phishing Reporter for GSuite accounts, as well as the client side when reporting emails. Administrators of the Cyberaware Security portal can observe through the Email Campaign results the number of reported emails as well as which recipients reported the email.
1. Navigate to Plugins:
2. Let’s manage the Plugin Configuration by clicking on it:
3. Enter an email address in the first box. That mailbox will be used to receive all recipient reported emails that were not part of the Cyberaware Security Email Campaigns. Essentially, it will filter out scheduled phishing campaigns intended for training/testing purposes, to distinguish emails that could potentially be real phishing attempts.
As stated, you may add multiple addresses separated by a comma.
4. Tick the following box to prompt recipients to provide a reason for reporting an email:
5. If you are satisfied with the configuration, click on Save changes:
6. As we can see, the settings have been updated!
7. Once the configuration process is done, let’s install the required reporter tool. Click on the following link to access the Google Workspace Marketplace. To install the add-on you need administrative privileges.
8. You should get the following output:
9. As guided by the installation process, select the option Admin install and click CONTINUE:
10. On the Allow Data Access window select the option Everyone at your organization and then click on the box to accept the terms of service. Finally click on Finish:
11. Click on Done on the message showing that the add-on has been installed:
12. Let’s have a look from the Gmail (web access) side of things. In the right bar , you will find the Cyberaware Security Phishing Reporter add-on was eventually added. Click on the specified button:
13. When we click on the Report a phishing mail button after selecting an email, we get the following option:
14. Click on Send report to finalise. In this instance, we will report this email using the default reason called Suspicious content. As always, a recipient may select the appropriate reason for their case. When selecting the Other reason option, a user will be asked to provide a description of the issue as well.
15. As we can see, the report has been submitted as expected!
16. If the email reported was part of a phishing campaign, reporting such email will trigger an update on the results of said campaign, indicating that the email has been reported:
17. On the other hand, if the email was not part of a campaign and has been reported, the email address that was added during the configuration step will receive an email containing an eml file so it can be viewed/replayed later. If the recipient has added a description during the reporting procedure, it will also be included.
# Active Directory
## Active Directory Guide
In this article, we illustrate how to properly set up the **Active Directory** functionality of the admin portal. Whether you utilise **on-premises** Active Directory or you are dependent in one from the **cloud** (**Azure AD**), by enabling this option, the **CYBERAWARE SECURITY** platform will retrieve and synchronise your groups and recipients accordingly.
**Prerequisites (Only for Azure AD Domain Services):**
Before you can integrate an Active Directory using **Azure AD Domain Services,** please make sure to visit and establish either of the following:
* [Create and configure an Azure Active Directory Domain Services managed domain](https://learn.microsoft.com/en-us/azure/active-directory-domain-services/tutorial-create-instance)
* [Configure secure LDAP for an Azure Active Directory Domain Services managed domain](https://learn.microsoft.com/en-us/azure/active-directory-domain-services/tutorial-configure-ldaps)
**1.** As a reference point, let's have a look at our [Groups](https://docs.cyberawaresecurity.com/admin-portal/groups) and [Recipients](https://docs.cyberawaresecurity.com/admin-portal/recipients). Before synchronisation, they are both empty:
**2.** Navigate to **Active Directory:**
**3.** Go ahead and select the **Enable AD Synchronisation** option:
You should get the following output:
**4.** Click on the **AD Sync installer.msi** in order to **download** it. You'll later need to install it.
After the installation, this service tool will be used to synchronise both ends, our **platform's client** with your **AD server.**
**5.** When enabling the **Active Directory Synchronisation,** you will be deprived of the opportunity for **manual creation** of **groups** and **recipients.** To be able to once again have the ability to manually create groups and recipients, click on the indicated buttons shown below:
**6.** Before you **Confirm,** **copy,** and essentially **store temporarily** the provided **configuration key;** you'll be required to use it when setting up the **config** file for the sync service (we will discuss this further down the line).
**7.** On the confirmation prompt that pops up, select to **Confirm** or **Cancel** accordingly:
**8.** If you’ve confirmed the action, click **OK** to proceed:
**9.** As we can see, the Active Directory Synchronisation has been enabled!
**10.** Now, let's go ahead and **open** up the installer you've downloaded earlier in order to **install** the sync service.
You will be prompted with the **Setup Wizard:**
**11.** To continue, click on **Next:**
You will be met with the **End-User License Agreement:**
**12. Accept** the terms and select **Next:**
**13. Choose** the destination for your folder and click on **Next** to proceed accordingly:
**14.** Click on **Install** to finally install the machine:
**15. Untick** the box to **avoid launching** the **AD Sync Manager** as we are yet to set up the config file. Click **Finish** to close the window.
**16.** Finally, navigate to the **directory/path** you've chosen during the installation steps and **open** up the **config** file:
In this instance, we are using **notepad** to open it. As always, you may use any **text editor** you might prefer.
**17.** When the file opens up, you will come across the following configuration:
**18.** It is a **must** to edit and **fill** the following fields:
*Please refer to the table below for more:*
| Attributes | Details |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **workspace\_key** | This is the **configuration key** we've previously stored when enabling the Active Directory Synchronisation. |
| **\[ldap] - host** | If the organisation is using a **local machine** to run the Active Directory role, you should add its **IP.** Otherwise, if your Active Directory runs on top of **Azure,** you should add the external IP address (**public**) or the **FQDN** of the Active Directory Services. Use **localhost** if the tool is installed on the Domain Controller. |
| **\[ldap] - port** | Could be port **389** or **636** for a **local** setup. For **Azure AD,** you can only use port **636.** |
| **\[ldap] - user** | For an **on-premises** configuration, this is the **username** of the profile you are using to **administer** Active Directory. If you are rather managing **Azure Active Directory Services,** you should leave this attribute **blank.** |
| **\[ldap] - pass** | This is the **password** required to gain access to the admin role. |
| **\[ldap] - enable\_tls** | Assuming you are using port **636,** for **secure ldap** (**ldaps**), the value of this attribute should be set to **true,** otherwise you should leave it as its **default** (**false**). |
| **\[ldap] - #bind\_str** | This attribute is a **comment** by **default.** It should only be **uncommented** if you are using **Azure.** It can take parameters such as the **user** managing the Azure AD, his/her **group,** and the **domain.** |
| **\[ldap.ad] - base\_dn** | Here, you should add the **domain** as a parameter. It should match the one you've added in the **bind\_str** attribute. |
**19.** It is **recommended** to **edit** the following fields as well, but they are **optional:**
You may essentially exclude groups which aren't needed, such as the group of **enterprise admins,** etc.
**20.** After **saving** the changes, go ahead and **load** the **manager** application that exists within the same folder:
The following window should then pop up:
**21.** Click on the **Start service** button to **start** the service:
**22.** The service is now **Running** as expected!
**23.** After some time, when the **synchronisation** is **complete,** we may distinguish that the **changes** have been **applied. Groups** and **Recipients** sections should now appear **updated:**
**24.** As always, you may **disable** the Active Directory Synchronisation feature from the button shown below:
**25.** On the prompt that will pop up, press on **Disable** or **Cancel** accordingly:
**26.** At the **last confirmation,** click **OK** to finalise.
# Audit Logs
## Audit Logs Guide
In this article, we exhibit in short terms the content of the **Audit Logs** section. **Admins** of the **CYBERAWARE SECURITY** platform are able to monitor logs regarding both **user** (administrator) and **recipient** (student) portals!
**1.** Navigate to **Audit Logs:**
By default, you’ll firstly reach the **Users logs** subsection which contains the **email** of the admin. Along with that, you can distinguish that user’s **actions** and their machine’s **IP Address.**
**2.** Click on the **Recipients logs** button to view the students’ logs:
**3.** As we can see, the recipients’ logs are now available:
Moreover, along with the email, **events** (actions) and IPs that were previously mentioned, you can of course observe the **timestamps** of said events in addition to further **details!**
# Brand Settings
## Brand Settings Guide
In this article, we explain the process of the **Brand Settings** customisation. Through brand settings, you may customise the student portal. You can upload your company’s logo and set the colours to match your organisation’s profile.
{% embed url="" %}
**1.** To **change** the **background** “branding” colour, click on the box that contains the hex colour code (**ex. 1e1e2d**):
**2.** Select any colour that you like from the canvas and click **Choose** to proceed or **Cancel** to drop the change.
**3.** To change the **Company Logo** image, click on the indicated option shown in the following screenshot:
You may select an image of your likes, as long as its size does not exceed the cap of **512 KB.**
**4.** On the right-hand side, you can find a preview of the result:
**5.** Finally, make sure that you click on **Save** to apply the changes:
**6.** From the **user portal,** this is how it looks like:
**7.** Let’s change it for demonstration purposes:
**8.** As we can see, the settings have been updated successfully!
# Student Notifications
## Student Notifications Guide
In this article, we explain how you can **manage** and **customise** **Student Notifications.** Notifications are sent to students regarding major events, such as **account creation** and participation in **training campaigns** organised by their company.
{% embed url="" %}
**1.** Navigate to the **Student Notifications** section of the portal:
**2.** Click on the **SMTP Configuration** button to choose which SMTP profile will be used to send the email notifications.
You can use any of your **customised** SMTP sending profiles, but if you have not created one yet, you can always use the one called **System** that is provided by default.
**3.** For this example, we will use the **default** system profile since we have not yet created a custom one.
If you wish to learn more on how to set up a custom SMTP profile, click on this [link](https://docs.cyberawaresecurity.com/admin-portal/smtp-profiles) and it will guide you to the appropriate article.
**4.** To **enable** any of the available notifications, just click on the button next to them:
**5.** Click on **Save** to apply the changes:
**6.** As we can see, the settings have been updated!
**7.** It is advised that you **always** have the **Account Creation** notification **enabled.** The reason behind this is simply that the email notification sent to the users will contain their **initial credentials to access the user portal.**
**8.** Let’s preview one of the available notifications. When clicking on the **Preview** option of a notification, it will be displayed on the browser exactly as how it would appear in the actual email.
**9.** Finally, you have the ability to customise any template available, but you will have to use some **HTML coding.**
**10.** To do so, click on the **Customise template** option:
For further instructions on how to appropriately use the **platform’s HTML editor tools** to customise your templates, please follow this [link](https://docs.cyberawaresecurity.com/admin-portal/email-templates) to our article.
# SSO (Single Sign-on)
## SSO (Single Sign-on) Guide
In this article, we explain the process of how an admin can set up the **SSO (Single Sign-on)** for their student (**/learn**) portal. This will enable users to sign into the portal application using their **Azure Active Directory** credentials.
**1.** Access your Azure portal and navigate to **Azure Active Directory.**
Please be advised that in order to enable SSO for users, they should exist in both the **cyberawaresecurity** and **Azure** platform.
**2.** From the menu on the left, go to **Enterprise applications.**
**3.** On the new directory, click on **New application.**
You should get the following output:
**4.** Select **Create your own application:**
**5.** Enter a name for your application. In this instance we will use **Examine** for demonstration purposes:
**6.** Make sure that the last option which states **Integrate any other application you don’t find in the gallery (Non-gallery)** is selected and click on **Create:**
It will direct you to **Browse Azure AD Gallery.** From there, you will be able to see a **Getting Started** section:
**7.** Click on the **Get started** option of the second step indicating **Set up single sign on.**
**8.** Choose the **SAML** option from the new prompt:
We will demonstrate **two ways** in which we can configure the SSO.
**9.** But before we do that, let's see how we can add **Users and groups:**
**10.** Click on the **Add user/group** option:
You will be prompted with the following:
**11.** From there, select the **None Selected** option to view the available **Users and groups:**
**12.** For this example, we will choose 1 group and 1 user and click on **Select:**
**13.** Click on **Assign** to finalise the process.
**14.** As we can see, the **Application assignment succeeded!**
**15.** Firstly, we will show the way where we **manually** configure the **Basic SAML Configuration.** To do that, click on the **Edit** button:
You should enter the links required:
**16.** The **Entity ID** is the actual URL of the portal.
**17.** The **Reply URL** is the URL of the portal with a **/saml/acs** added at the end.
**18.** The **Sign on URL** or the **student portal link,** is essentially the URL of the portal with a **/learn** at the end.
**19.** Finally, enter the **Logout Url** which is the **portal’s URL** with **/saml/slo** added at the end of the link.
**20.** Let’s make an example:
**21.** At the **Entity ID,** click on the **trash can** button next to the **default URL** to **delete** it:
This will automatically set our link as **Default:**
**22.** Click on **Save** to proceed.
**23.** As we can see, the single sign-on configuration was saved successfully!
**24.** As a next step, you will have to navigate back to the **Set up Single Sign-On with SAML:**
**25.** Moreover, in a new tab or window, open and log in to your **cyberawaresecurity** platform branch. This is essentially your **Entity ID URL,** so for this demonstration we will be using the **examine:**
**26.** To enable Single Sign-on, scroll down and click on the **SSO (Single Sign-on)** section:
**27.** From there, click on the button right next to **Enable Single Sign-on.**
You should get the following output:
**28.** We will take the information required from **Azure.** Switch back to your **Set up Single Sign-On with SAML** window:
**29.** Scroll down to the **3rd point** called **SAML Signing Certificate** and **copy** the **App Federation Metadata Url.** To do that, **click** on the indicated button of the following screenshot:
This will be your **IDP Metadata URL:**
**30.** Let’s use our **IDP Metadata URL** for demonstration:
For the **Attributes & Claims** records of the **SSO Configuration,** you will have to navigate to the **User Attributes & Claims.**
**31.** From the **Set up Single Sign-On with SAML** window, find the **2nd point** called **User Attributes & Claims** and click on the **Edit** button:
You should get the following output:
**32.** Before we start copying everything to the SSO Configuration, there is a change we must apply. Click on the **user.mail** attribute so we can edit:
**33.** As guided in the **Required claim,** let’s **replace** the **user.mail** with **user.userprincipalname:**
**34.** Click on **Save** to apply the changes:
**35.** As we can see, the value has been replaced successfully!
**36.** Finally, let’s enter the rest of the attributes, starting with **Unique ID.** This would be the suggested URL, but we replace the **/emailaddress** with **/mail** at the end of the link.
In other words:
**37.** The rest of the details we can just copy and paste accordingly:
**38.** Click on the **Save** button:
**39.** As we can see, the SSO configuration was updated successfully!
**40.** Let’s also demonstrate the **alternative** way to configure SSO where the **Basic SAML Configuration** is configured **automatically.** To do that, complete the **first 8 steps.** You should reach the **Set up Single Sign-On with SAML** window:
**41.** Select the **Edit** button of the **Basic SAML Configuration:**
You should enter the links required:
**42.** The links are the same as before, so let’s enter them and save the changes!
**43.** As we can see, the **single sign-on configuration** was saved successfully!
**44.** Finally, complete the rest of the steps (**19-33**) so the SSO configuration is in place, and you reach the confirmation prompt:
**45.** From there, click on the **Download Metadata XML** button:
You should get the following file:
**46.** To conclude the process, switch back to your **Set up Single Sign-On with SAML** window and click on the **Upload metadata file** option:
**47.** Enter the **metadata** file and click on the **Add** button:
**48.** The **SAML** file will be uploaded as expected and the **Basic SAML Configuration** prompt will pop up:
**49.** Click on the **Save** button to apply the changes:
**50.** As expected, the configuration was saved successfully!
**51.** Close the **Basic SAML Configuration** prompt to view the added details:
**52.** You can now go ahead and login as a user in the student (**/learn**) portal. Since SSO has been enabled, you will be redirected to the Microsoft login screen:
# How to reset your password (For recipients)
In this article, we explain the process of **resetting** the password for a **recipient** in the **user** portal.
{% embed url="" %}
**1.** Navigate to your user portal:
**2.** Click on the **Forgot password?** option:
**3.** You should get the following output:
**4.** Enter your **email address** or **username** and select the **Reset Password** button:
**5.** You should receive the following email in your related email inbox:
**6.** Click on the **Reset My Password** button:
**7.** You will be prompted with the following window.
**8.** Put the **new** password **twice** in order to **confirm** it and click on **Save:**
**9.** As we can see, the password has been updated!
# User Portal
## User Portal Guide
In this article, we demonstrate how users can navigate and interact with the online **User Portal.** The platform is entirely web based and supports all modern web browsers including Firefox, Chrome, Edge and Safari. In this platform, users can be assigned training courses and those who are successful can benefit from additional rewards such as certifications and badges!
**1.** Login to your **cyberawaresecurity** profile:
**2.** As you can see, at the top of the page you can find related training information such as total courses, progress, time spent and so on.
**3.** Under the training information, you can find the available courses and their status:
**4.** From the following option, you may change the language for your profile’s interface:
**5.** The changes are applied **instantly:**
**6.** Select the **three dots** option next to your avatar. From there you can navigate to your **Profile** or **Logout:**
**7.** Alternatively, you can do this from your “name” button placed on the right-upper corner:
**8.** Let’s visit the profile page (**My Profile**):
You can check and verify your details, but for changes you will have to reach out to your department’s responsible admin.
**9.** Go back to the **Home** page using the following button:
**10.** From the menu on the left, we can see some account details and achievements such as **Email, Level** and **Points:**
**11.** Right beneath these account details, we can see the **certifications** we have earned so far with this user account. Let’s click on the “cloud” button next to one of them so we can **download** it:
**12.** If the **pdf** file is downloaded, go ahead and **open** it in order to view your certification. It should look like this:
**13.** Return to the platform and scroll down a bit further to find your obtained **badges:**
**14.** Finally, if you have available **active** courses for training (assuming you have not completed them), you will be able to either **start** or **resume** them:
**15.** Click on any of them. You should expect a similar output to this:
# How to change an administrator's password as an admin
In this article, we explain the process of **changing** the password for an **administrator** through the **admin** portal.
{% embed url="" %}
**1.** Navigate to the **User Management** section of the admin portal:
**2.** Click on the **pencil** button to edit an admin’s details:
**3.** Finally, enter the **new** password **twice** and click on **Save changes** to confirm. Alternatively, **Close** the **Update user** window:
**4.** As we can see, the admin profile called trainer has been updated successfully!
# How to change a recipient's password as an admin
In this article, we explain the process of **changing** the password for a **recipient** through the **admin** portal.
{% embed url="" %}
**1.** Navigate to the **Recipients** section of the admin portal:
**2.** Click on the **eye** button to view a recipient’s details:
**3.** Finally, to change the recipient’s password click on the **Change Password** option:
**4.** Enter the **new** password **twice** and confirm it through the **Change Password** button. Alternatively, **Cancel** the change.
**5.** If you are sure about the change, choose **Add** or **Cancel** to reject it:
**6.** On the confirmation prompt that pops up, select **OK** to finalise.
# How to reset your password (For administrators)
In this article, we explain the process of **resetting** the password for an **administrator** in the **admin** portal.
**1.** Navigate to your admin portal:
**2.** Click on the **Forgot password?** option:
**3.** You should get the following output:
**4.** Enter your **email address** or **username** and select the **Reset Password** button:
**5.** You should receive the following email in your related email inbox:
**6.** Click on the **Reset My Password** button:
**7.** You will be prompted with the following window.
**8.** Put the **new** password **twice** in order to **confirm** it and click on **Save:**
**9.** As we can see, the password has been updated!
# Whitelist IPs and Domains
In this article, we provide our domain’s **IPs** and **Hostnames** for the process of whitelisting. Organisations with stricter restrictions that want to use our **default** SMTP profile for [Email Campaigns](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns) and [Student Notifications](https://docs.cyberawaresecurity.com/admin-portal/student-notifications) will have to essentially **approve** on an administrator level our domain, so the emails are not denied or recognised as **spam/junk.**
| **Hostname:** | **IP Addresses:** |
| :----------------------: | :---------------------------------------: |
| cyberawaresecurity.email |
162.240.27.86
162.240.32.173
|
| cyberawaresecurity.cloud |
162.240.39.188 160.240.40.25
|
# Microsoft 365 Whitelist
In this article, we explain the process of **domain whitelisting.** If your organisation operates under the restrictions and security policies of **Microsoft Office 365,** you will need to follow the guidelines provided down below. In this way, you will be able to execute “testing” phishing campaigns towards your personnel, but also send out [Student Notifications](https://docs.cyberawaresecurity.com/admin-portal/student-notifications) regarding their training.
{% embed url="" %}
**1.** Login to your **Microsoft 365 admin profile** and navigate to your apps. Select the **Admin** option:
**2.** Click on **Show all** to expand:
**3.** Navigate to the admin center using the **Security** option:
**4.** As From the menu, click on the **Email & collaboration**
**5.** Go to **Policies & rules** so you can start setting up your whitelist rules:
**6. From Policies & rules click on Threat policies** :
**7. Click on Advanced delivery:**
**8.** Click on **Phishing simulation**:
**9.** Click on **edit**:
**10.** Set the domain(s) you would like to **Whitelist** :
**11.** Set the domain(s) you would like to **Whitelist from** simulation URLs to allow :
**12.** Finally, click on **Save** to apply the changes:
Failing to do so will result in emails arriving at the **spam/junk** folders of target users’ inboxes! Click [here](https://docs.cyberawaresecurity.com/admin-portal/training-campaigns) to learn more about **Training Campaigns** or [here](https://docs.cyberawaresecurity.com/admin-portal/email-campaigns) to dive deeper into **Email Campaigns!**
# Browser Support
In this article, we are kindly informing you that **CYBERAWARE SECURITY** is in accordance with all modern browsers, such as Google Chrome, Mozilla Firefox, Microsoft Edge, Safari, Opera, etc. Our platform is also compatible with all browsers used by the latest mobile devices (i.e., iOS and Android).