zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-07-25 12:08:21 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add docs on template files

Browse source
This commit is contained in:
Bryan Ashby 2019-06-16 11:01:58 -06:00
parent abc6a36275
commit da961c34a7
No known key found for this signature in database
GPG key ID: B49EB437951D2542
5 changed files with 42 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
art/themes/luciano_blocktronics/2FAOTP.ans Normal file
View file

Binary file not shown.

20
docs/modding/user-2fa-otp-config.md
View file

@ -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.

11
misc/otp_register_email.template.html Normal file
View file

@ -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>

7
misc/otp_register_email.template.txt Normal file
View file

@ -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%