From 17f49a52dea092ebad81c0a0fce537bd65f522f0 Mon Sep 17 00:00:00 2001 From: Ilya Kreymer Date: Mon, 8 Apr 2024 12:27:47 -0700 Subject: [PATCH] email templates update + customization + doc update (fixes #1652) (#1653) - modify invite email template to answer common questions - email templates: make each email template overridable with --set-file - docs: update customization doc to document how to customize email templates --------- Co-authored-by: Tessa Walsh --- chart/email-templates/invite | 52 ++++++++++++++++++++++------------ chart/templates/configmap.yaml | 6 +++- docs/deploy/customization.md | 31 ++++++++++++++++++++ 3 files changed, 70 insertions(+), 19 deletions(-) diff --git a/chart/email-templates/invite b/chart/email-templates/invite index 72a8837d..053d1641 100644 --- a/chart/email-templates/invite +++ b/chart/email-templates/invite @@ -12,28 +12,35 @@ Welcome to Browsertrix! {% endif %} {% if is_new %} -

You can now set up your account using the link below.

+

We're excited you're here and can't wait to help you get started crawling! You can now set up your account using the link below.

Click here to create an account.

{% else %}

Click here to accept this invite.

{% endif %} -

When you first access your account, you’ll be directed to your Dashboard. It contains information you may want to view frequently including: Storage Usage, Crawling Info, Collections, and Monthly Usage History. From there, you can click + Create New to create your first Crawl Workflow! - - -

For more info, check out the Browsertrix User Guide

- +

Here's what you should do first off to get the most value out of your experience:

-We want you to get the most from your Browsertrix experience! +Step 1: Create your login credentials
+Step 2: Review the Browerstrix User Guide
+Step 3: Invite additional users from your organization

-

Let us know if you need any questions or feedback.

-You can connect with our team at {{ support_email }}

+

When you first access your account, you'll be directed to your Dashboard. It contains information you may want to view frequently including: Storage Usage, Crawling Info, Collections, and Monthly Usage History. From there, you can click + Create New to create your first Crawl Workflow!

+ +

To help you get up to speed, here are the top three questions our users normally have on the first day:

+ +

+How do I crawl my first website?
+How do I create a browser profile?
+How do I export my archived items?

-

The Webrecorder Team

+

If you need any assistance, please direct your questions to {{ support_email }}

+ +

Best Regards,

+

The Webrecorder Team

~~~ @@ -46,19 +53,28 @@ You have been invited by {{ sender }} to join their organization, "{{ org_name } {% else %} -You can join by clicking here: {{ invite_url }} +We're excited you're here and can't wait to help you get started crawling! You can now set up your account using the link below. + +{{ invite_url }} {% endif %} -When you first access your account, you’ll be directed to your Dashboard. It contains information you may want to view frequently including: Storage Usage, Crawling Info, Collections, and Monthly Usage History. +Here's what you should do first off to get the most value out of your experience: -For more info, check out Browsertrix User Guide at: https://docs.browsertrix.cloud/user-guide/ +Step 1: Create your login credentials +Step 2: Review the Browerstrix User Guide (https://docs.browsertrix.cloud/user-guide/) +Step 3: Invite additional users from your organization (https://docs.browsertrix.cloud/user-guide/org-settings/) +When you first access your account, you'll be directed to your Dashboard. +It contains information you may want to view frequently including: Storage Usage, Crawling Info, Collections, and Monthly Usage History. +From there, you can click +Create New to create your first Crawl Workflow! (https://docs.browsertrix.cloud/user-guide/workflow-setup/) -If you ever need to reset your password, go here: {{ origin }}/log-in/forgot-password - - -We want you to get the most from your Browsertrix experience. Let us know if you need any questions or feedback. -You can connect with our team at {{ support_email }}. +To help you get up to speed, here are the top three questions our users normally have on the first day: +How do I crawl my first website? (https://docs.browsertrix.cloud/user-guide/workflow-setup/) +How do I create a browser profile? (https://docs.browsertrix.cloud/user-guide/browser-profiles/) +How do I export my archived items? (https://docs.browsertrix.cloud/user-guide/archived-items/#crawl-settings) +If you need any assistance, please direct your questions to {{ support_email }}. +Best Regards, +The Webrecorder Team diff --git a/chart/templates/configmap.yaml b/chart/templates/configmap.yaml index c19255d9..a7fe0437 100644 --- a/chart/templates/configmap.yaml +++ b/chart/templates/configmap.yaml @@ -147,4 +147,8 @@ metadata: namespace: {{ .Release.Namespace }} data: -{{ (.Files.Glob "email-templates/*").AsConfig | indent 2 }} +{{- $email_templates := .Values.email.templates | default dict }} +{{- range tuple "failed_bg_job" "invite" "password_reset" "validate" }} + {{ . }}: | +{{ ((get $email_templates . ) | default ($.Files.Get (printf "%s/%s" "email-templates" . ))) | indent 4 }} + {{- end }} diff --git a/docs/deploy/customization.md b/docs/deploy/customization.md index e50349e9..d73b787d 100644 --- a/docs/deploy/customization.md +++ b/docs/deploy/customization.md @@ -112,6 +112,37 @@ frontend_avg_memory_threshold: 95 Browsertrix sends user invitations, password resets, background job failure notifications, and other important messages via email. The `email` setting can be used to configure the SMTP server used to send emails. To avoid email messages from Browsertrix being flagged as spam, be sure to use the same domain for `sender_email` and `reply_to_email`. + +### Customizing Email Templates + +It is also possible to custom the HTML/plain-text email templates that Browsertrix sends out with a custom `--set-file` parameter for `email.templates.` pointing to an alternate template file. For example, to use a custom `invite.html` for the invite template, add: + +```shell +helm upgrade --install btrix ... --set-file email.templates.invite=./invite.html +``` + +The list of available templates (and their default content) [is available here](https://github.com/webrecorder/browsertrix-cloud/tree/main/chart/email-templates) + +The format of the template file is, for HTML emails: + +``` +Subject +~~~ +HTML Content +~~~ +Text Content +``` + +or, for plain text emails: + +``` +Subject +~~~ +Text +``` + +The `~~~` is used to separate the sections. If only two sections are provided, the email template is treated as plain text, if three, an HTML email with plain text fallback is sent. + ## Signing WACZ files Browsertrix has the ability to cryptographically sign WACZ files with [Authsign](https://github.com/webrecorder/authsign). The ``signer`` setting can be used to enable this feature and configure Authsign.