Add docs on template files

NuSkooler · Jun 16, 2019 · da961c3 · da961c3
1 parent abc6a36
commit da961c3
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 4 deletions.
diff --git a/art/themes/luciano_blocktronics/2FAOTP.ans b/art/themes/luciano_blocktronics/2FAOTP.ans
diff --git a/docs/modding/user-2fa-otp-config.md b/docs/modding/user-2fa-otp-config.md
@@ -51,3 +51,23 @@ The following MCI codes are available:
 * MCI 3: (ie: `TM3`): Submit/cancel toggle.
 * MCI 10...99: Custom entries with the following format members available:
     * `{infoText}`: **Info Text** for current selection.
+
+### Web and Email Templates
+A template system is also available to customize registration emails and the landing page.
+
+#### Emails
+Multipart MIME emails are send built using template files pointed to by `users.twoFactorAuth.otp.registerEmailText` and `users.toFactorAuth.otp.registerEmailHtml` supporting the following variables:
+* `%BOARDNAME%`: BBS name.
+* `%USERNAME%`: Username receiving email.
+* `%TOKEN%`: Temporary registration token generally used in URL.
+* `%REGISTER_URL%`: Full registration URL.
+
+#### Landing Page
+The landing page template is pointed to by `users.twoFactorAuth.otp.registerPageTemplate` and supports the following variables:
+* `%BOARDNAME%`: BBS name.
+* `%USERNAME%`: Username receiving email.
+* `%TOKEN%`: Temporary registration token generally used in URL.
+* `%OTP_TYPE%`: OTP type such as `googleAuth`.
+* `%POST_URL%`: URL to POST form to.
+* `%QR_IMG_DATA%`: QR code in URL image data format. Not always available depending on OTP type and will be set to blank in these cases.
+* `%SECRET%`: Secret for manual entry.
diff --git a/misc/otp_register_email.template.html b/misc/otp_register_email.template.html
@@ -0,0 +1,11 @@
+<b>%USERNAME%</b>:<br>
+<br>
+<p>
+	You have requested to enable 2-Factor Authentication via One-Time-Password for your account on <b>%BOARDNAME%</b>.<br>
+</p>
+<p>
+	If this was not you, please ignore this email and <u>consider changing your password</u>. Otherwise, <a href="%REGISTER_URL%">please follow this link</a> or copy and paste the link below:<br><br>
+	%REGISTER_URL%<br>
+</p>
+
+
diff --git a/misc/otp_register_email.template.txt b/misc/otp_register_email.template.txt
@@ -0,0 +1,7 @@
+%USERNAME%:
+
+You have requested to enable 2-Factor Authentication via One-Time-Password for your account on %BOARDNAME%.
+
+If this was not you, please ignore this email and consider changing your password. Otherwise, please follow the link below:
+
+%REGISTER_URL%
diff --git a/www/otp_register.template.html b/www/otp_register.template.html
@@ -1,11 +1,11 @@
 <!doctype html>
 <html lang="en">
-	<head>
-		<meta charset="utf-8">
+    <head>
+        <meta charset="utf-8">
         <title>Enable 2FA/OTP — ENiGMA½ BBS</title>
         <meta name="description" content="Enable 2-Factor Authentication via One-Time-Password">
-		<meta name="viewport" content="width=device-width, initial-scale=1">
-	</head>
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+    </head>
 	<body>
         <p>
             Your OTP secret:<br>