# Awareness Templates ## Add an Awareness Template Select **+ New Awareness** to view the template gallery. Search for an Awareness template, select **Use Template**, and select the default language to begin using the template.
*** ## Base Settings Once a template is added to the campaign you can find it under **Awareness Settings**. Select a template to edit its settings and content.
#### Name By default, the original template name will be populated, but you can change this name to apply only to the specific campaign associated with the awareness template. #### Risk Level By default, your awareness template is set to Risk Level 0. Each additional training will have a risk score incremented by 1. Risk level is 1:1 with the number of attack simulations a recipient has failed. #### Website Enabled Select this option if you want the user to be directed to a landing page to complete their training. Typically, this setting should be enabled to gather statistical data on the user's training metrics. Only disable it if you intend for the user to receive an email without tracking their training progress. {% hint style="success" %} After you enable this option, select **Save** to apply it. This will add additional tabs to the settings where you can configure the website and edit its content. {% endhint %} #### Create Awareness Training Diploma This option is available only for awareness templates that include a Quiz/Exam. It is designed to automatically send users a predefined Training Diploma once they have successfully completed the training and achieved a score above the minimum passing threshold. {% hint style="success" %} After you enable this option, select **Save** to apply it. This will add additional tabs to the settings where you can configure the certificate and edit its content. {% endhint %} #### Languages This is the default language setting for your template. If a user is imported into Lucy without a specified language, they will receive the awareness scenario in the default language selected here. {% hint style="info" %} Most templates are available in our core languages. If you need a translation in a language not already provided, select that language in this tab. You will then have the opportunity to manually translate the content in the subsequent steps of this article. {% endhint %} *** ## Website The Website tab contains settings related to the training content, such as the hosting domain, behavior, and content. ### Settings {% tabs %} {% tab title="Domain" %} Define the base domain to which the user will be redirected to access their awareness training content. You can also specify a subdomain, which is the portion of the URL before the base domain, such as **training**.lucysecurity.com {% hint style="success" %} If you are using a domain owned by your company, all [DNS records](/application-reference/settings/common-system-settings/domains.md#dns-records-explained) must be correctly configured to point to your Lucy server for successful mail delivery. {% endhint %} {% endtab %} {% tab title="Quiz Options" %} #### Quiz By default, if your campaign contains a Quiz or Exam, the "Quiz" selection box will be enabled. This means that once the user completes the first quiz, they will be marked as trained. Additionally, the system will provide the score and a list of answers submitted by the user which can be viewed in the [statistics section of the campaign results](/application-reference/campaigns/campaign-settings/results/statistics.md#awareness-website). #### Extended Tracking This option tracks when users complete a pre-defined Quiz or Exam. For instance, in Awareness templates containing multiple quizzes, enabling only the **Quiz** option will log the result of the first quiz the user interacts with. With this option enabled, you can specify which quiz or exam determines the user's score. To activate this feature, you need to add a call to the "lucyQuizEnd()" function without any parameters. Launch this function after the user answers the last question in your quiz. More information can be found [here](/guides/awareness-training/use-extended-method-of-tracking-the-end-of-the-quiz.md). {% hint style="danger" %} If you enable this option **without** calling the `lucyQuizEnd()` function recipients will **not** be marked as **Trained** in the campaign statistics. {% endhint %} #### Success Score A minimum score the user must receive in order to be marked as **Trained** and receive a diploma. {% endtab %} {% tab title="Preview Link" %} The preview link offers a public URL for sharing with colleagues who do not have access to the Lucy administration panel. This feature is ideal for validating campaigns across different departments without running a campaign or adding stakeholders as administrative users on your Lucy server. {% endtab %} {% tab title="Language" %} Each edit is confined to the selected language. If the default template does not include your target language, you can add and manually translate all text into the desired language. Remember to click 'Save' to commit the changes for each language. {% hint style="warning" %} Editing templates after binding them to a campaign commits the changes only to that specific campaign, not to the original template. Editing a template within a campaign should be campaign-specific, indicating that the modifications are exclusive to that campaign and not intended for reuse in future campaigns. For more information, see our guide on [customizing Awareness templates](/guides/awareness-training/awareness-template-customization.md). {% endhint %} {% endtab %} {% endtabs %} ### Content See our guide for editing awareness content [here](/guides/awareness-training/awareness-template-customization.md). *** ## SSL Settings If the website is enabled, you'll need SSL for the hosting domain. Select the checkbox to include an SSL certificate:
{% tabs %} {% tab title="Select Existing" %} Choose this option if you have already generated an SSL certificate on your Lucy server. This option allows you to reuse the existing certificate. {% hint style="info" %} Be advised that the validity period of the existing certificates will not be extended. {% endhint %} {% endtab %} {% tab title="Generate or Upload" %} This option is ideal if you already have an SSL certificate chain from a trusted certificate authority or if you would like to generate a self-signed certificate. {% hint style="warning" %} Be aware that self-signed certificates are not issued by trusted certificate authorities. As a result, browsers will mark your domain as not secure when using these certificates. {% endhint %} **Option 1: Generate a self-signed Certificate**
1. **Domain**: Enter the domain name for which you want to generate the SSL certificate (e.g., lucysecurity.help). 2. **Email**: Provide a valid email address. This is where Let's Encrypt will send notifications about your certificate, such as renewal reminders. 3. **Details**: Fill in the Country, State, City, Organization Name, and Organizational Unit. These details are often used in the certificate's subject field and can be important for organizational certificates. 4. **Generate**: Click on the "Generate Certificate" button to create your self-signed certificate. #### Option 2: Upload an Existing Certificate 1. **SSL Certificate**: Click "Choose File" to browse and select your existing certificate file (usually a `.crt` or `.pem` file). 2. **SSL Key**: Click "Choose File" to upload the private key file associated with your SSL certificate (this is a `.key` file and must be kept secure). 3. **SSL Key Password**: If your private key is password-protected, enter the password here. 4. **SSL Chain**: Click "Choose File" to upload the chain file (also known as the CA bundle or intermediate certificate) if required. This is needed for browsers to trust your certificate by establishing a chain of trust to a root certificate. 5. **Wildcard**: If you are uploading a wildcard certificate, you would check the "Wildcard" box. Wildcard certificates secure a domain and all its subdomains (e.g., `*.example.com`). {% endtab %} {% tab title="Let's Encrypt" %} Our default method, designed for maximum user-friendliness, enables your Lucy server to automatically generate a Certificate Signing Request (CSR) through the integrated Let's Encrypt API. It then submits this request to Let's Encrypt and automatically installs the full certificate chain on your Lucy server. This process may take up to 5 minutes to complete. Please wait for the "certificate successfully generated" notification before proceeding further. {% hint style="info" %} Let's Encrypt certificates are issued with a maximum validity period of 90 days. {% endhint %} {% hint style="danger" %} Please be aware that Let's Encrypt, a third-party SSL provider, imposes certain limitations. One notable restriction is the issuance cap of no more than 5 certificates per week for the same domain name. For additional details on these limitations, you can visit: [Let's Encrypt Rate Limits](https://letsencrypt.org/docs/rate-limits/). {% endhint %} {% endtab %} {% endtabs %} {% hint style="success" %} See our platform reference article [SSL Settings](/application-reference/settings/common-system-settings/ssl-settings.md) for more information. {% endhint %} *** ## Certificate The certificate tab pertains to the recipient's completion training diploma certificate, issued when the user successfully achieves a score above the pre-configured pass threshold on the quiz. {% hint style="info" %} Ensure **Create Awareness Training Diploma** is enabled in the **Base Settings**. {% endhint %} #### Select a Template To begin, select a language and an orientation for the certificate, then choose one of the ready-made options: {% hint style="warning" %} Settings are not automatically shared across Languages; all adaptations must be applied to each selected language. Translated content must be applied separately. {% endhint %}
Provide a suitable title to be displayed as the subject in the email when users receive their Training Diploma attachment.
#### Template Content Use the WYSIWYG editor to make changes to the diploma. **index.html** - the main content file **content.html** - the email message **style.css** - CSS for the content file
Certificate Variable Placeholders In the certificate template, you can use the following variables: * `%name%` — name of the certificate recipient. * `%awareness%` — name of the awareness training. * `%gender("MALE ADDRESSING", "FEMALE ADDRESSING", "NO GENDER")%` — recipient's gender. * `%score%` — recipient's score. * `%date%` — date of the certificate. * `%time%` — time of the certificate issuance. Please note that these variables are not available in CSS and JavaScript files.
*** ## Certificate Message
#### Subject The subject line of the email. #### Sender Name The name of the sender. This can be anything you want. #### Sender Email The email address of the sender. This does **not** need to be an existing email address, but the domain **does** need to point to your Lucy server. For best results, use the same domain as your awareness website. *** ## Message
Email Variables When creating email templates, you can personalize the content by using various placeholders that will be automatically replaced with specific user data when the email is sent. Below is an explanation of each variable available for use in the templates: * `%link%`: This variable represents the base URL of your site. Use it to construct absolute URLs for navigation within your emails. * `%user-password-reset%`: This placeholder is replaced with the unique URL for a password reset action. * `%user-profile-link%`: Inserts a direct link to the user's profile page in the End User Portal. * `%user-login-url%`: Provides a link to the End User Portal that utilizes SSO (OAuth 2.0) for login. * `%name%`: The full name of the email recipient. * `%firstname%`: The recipient's first name. * `%lastname%`: The recipient's last name. * `%email%`: The recipient's email address. * `%client%`: The name of the client associated with the recipient. * `%gender("MALE ADDRESSING", "FEMALE ADDRESSING", "NO GENDER")%`: This is a conditional variable that changes the greeting or addressing based on the recipient's gender. * `%subject%`: The subject line of the phishing email. * `%sender%`: The name of the sender of the phishing email. * `%sender-email%`: The email address from which the phishing email is sent. * `%started%`: The date when the related phishing campaign was started. * `%stopped%`: The date when the related phishing campaign was stopped. * `%time(FORMAT, OFFSET, ZONE)%`: A dynamic time variable where: * `FORMAT` refers to the format in which the date/time should be displayed. * `OFFSET` is the time offset from the mail send time, which can be positive or negative. * `ZONE` is the time zone to be applied. * Example: `%time("l, H:i", "0", "Europe/Zurich")%` would display the time of the email submission in the Europe/Zurich time zone. * Example: `%time("Y/m/d H:i:s", "60")%` would show a timestamp one hour ahead of the email submission time. Note that these variables are intended for use in the HTML body of the email and are not applicable within CSS and Javascript files. They serve to customize the email content for each recipient and should be used accordingly to ensure a personalized user experience.
{% tabs %} {% tab title="Attachments" %} Add your own attachments. Keep in mind that most common email clients filter certain types of attachments, like executables, to prevent malware risks. {% endtab %} {% tab title="General Email Settings" %} Set custom SMTP headers to meet specific needs. For example, you can add a custom email header to help your SPAM gateway distinguish between actual SPAM and emails sent from LUCY. {% endtab %} {% tab title="Advanced Email Settings" %} * Send emails as plain text. * **Random Email**: LUCY will generate a random email account with a random sender. The email account will be deleted after the campaign ends. If you want to catch email replies from your awareness email, LUCY provides two options: 1. **Define a Reply-to Header**: * The Reply-to address is where email replies are directed, rather than the 'From' address. This is useful if the 'From' address cannot receive replies, for example, if you do not control the domain or lack a mail server setup for it. For instance, if the email shows as being sent from "" and the recipient clicks reply, the email will be directed to the Reply-to address set in the header, such as "". Choose a Reply-to address you have access to. 2. **Define a Forward Mail**: * LUCY can forward incoming replies to a specified email address. This requires setting a [DNS entry (MX record)](/application-reference/settings/common-system-settings/domains.md#dns-records-explained) for the sender’s domain that points to LUCY. For example, if you send emails from "" and LUCY's IP is 201.35.77.12, you need an MX record like "phishing-test.com MX 10 201.35.77.12". Enter your own custom mail address in the forward mail field (e.g., ""). When someone replies to "", LUCY receives the email and forwards it to "". Note that many registration services offer free mail/DNS packages, allowing you to set up an email forwarder directly at the domain level, eliminating the need for LUCY’s forwarding feature. {% endtab %} {% tab title="DKIM Support" %} **DKIM Overview:** DomainKeys Identified Mail (DKIM) enhances email security by attaching a domain name identifier to a message, utilizing cryptographic techniques to validate authorization. This identifier is separate from other message identifiers such as the author's "From" field. DKIM effectively 'signs' emails to verify their origin, helping to identify and prevent spoofed emails. The process involves the sending mail server signing the email with a private key, while the receiving server uses a public key listed in the domain's DNS to verify the signature. Each domain can list multiple DKIM keys in its DNS, but each private key is unique to one mail server. **Setting Up DKIM in LUCY:** 1. **Enable DKIM:** * Navigate to "Advanced Email Settings" in the message template of your Attack Scenario. Enable DKIM support and save the changes. A DKIM information box will then appear. 2. **DNS Configuration:** * Copy the provided key and create the corresponding DNS entry. Here’s an example of how to set it up with namecheap.com: ``` Name: selector._domainkey Type: TXT Value: "v=DKIM1; k=rsa; p=[YOUR_PUBLIC_KEY]" ``` **Validate DKIM Setup:** * To confirm your DKIM is working, add an email from a service like [dkimvalidator.com](https://dkimvalidator.com/) to your DKIM test recipient group. Launch the campaign targeting this group, then check the results at dkimvalidator.com. If configured correctly, your setup should match the expected status. **DKIM Header Details:** The DKIM signature is added to emails as an RFC2822 header field. Here's a breakdown of the common fields in a DKIM signature: * **b:** Digital signature of the email's contents. * **bh:** Hash of the email body. * **d:** Signing domain. * **s:** Selector used for the DKIM signature. * **a:** Signing algorithm, typically rsa-sha1. * **c:** Canonicalization algorithm for the header and body. * **q:** Default query method, usually DNS. * **t:** Timestamp of when the email was signed. * **x:** Expiry time of the signature. * **h:** List of header fields that were signed. This setup ensures that emails sent through LUCY's mail server are authenticated, boosting trust and security for your email campaigns. {% endtab %} {% endtabs %} *** ## Mail Settings Administrators have two choices for setting up mail delivery: globally or at the campaign level. Global settings affect all campaigns but can be overridden by campaign-specific settings, which only apply to the selected campaign. This flexibility allows for customized mail delivery preferences on a per-campaign basis: {% tabs %} {% tab title="Use System Settings" %} {% hint style="info" %} Navigate to [Settings -> Common System Settings -> Mail Settings](#mail-settings) {% endhint %} Here you can choose your default method for sending emails. This setting will apply to all campaigns. {% endtab %} {% tab title="Internal Postfix Server" %} Lucy incorporates a built-in internal mail server (Postfix) as its default method for email delivery. This approach is straightforward and often used due to its direct integration within Lucy. To enhance delivery success, it's advisable to align the server's name with Lucy's Fully Qualified Domain Name (FQDN), potentially using a subdomain designated for mail purposes. {% endtab %} {% tab title="External SMTP Server" %} Lucy allows the configuration of an external SMTP server via its general settings. This is particularly useful when aiming to circumvent spam filters that may block emails from new or untrusted IP addresses. Setting up involves adding your mail server details under "[Settings -> Common System Settings -> SMTP Servers](/application-reference/settings/common-system-settings/smtp-servers.md)"; followed by a connection test to ensure proper setup. {% endtab %} {% endtabs %} *** ## Awareness Groups This feature is designed to automate the provisioning of multiple awareness templates based on three pre-defined goals. 1. Group recipients into Awareness Groups and serve them training content related to their day-to-day activities 2. Automate the sending of awareness content based on the recipient's [**risk level**](/application-reference/users/risk-score.md) 3. Use the [Scheduler](/application-reference/campaigns/campaign-settings/optional-settings/schedule.md) to create specific rules for different scenarios to manage selected Awareness Groups. {% hint style="warning" %} Awareness Groups are active only in campaigns with awareness scenarios. {% endhint %} Click [here](/guides/awareness-training/awareness-only-campaigns/using-awareness-groups.md) for a guide on using Awareness Groups. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://wiki.lucysecurity.com/application-reference/campaigns/campaign-settings/main-settings/awareness-education/awareness-templates.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.