lfk
/
mailer
3
0
Fork 0
Code Issues Pull Requests Projects Releases 3 Wiki Activity

Added env var docs to readme
continuous-integration/drone/pr Build is passing Details 

ref #3
This commit is contained in:
Nicolai Ort 2021-03-03 18:45:06 +01:00
parent e48f830c08
commit 5314100065
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,4 +1,4 @@
# mailer
# @lfk/mailer
[![Build Status](https://ci.odit.services/api/badges/lfk/mailer/status.svg?ref=refs/heads/main)](https://ci.odit.services/lfk/mailer)
Handles mail generation and sending (pw reset, welcome mail, etc)
@ -16,7 +16,6 @@ Handles mail generation and sending (pw reset, welcome mail, etc)
yarn dev
```
## Templates
> The mailer uses html and plaintext templates to generate various mails.
> The templates are stored in src/templates by default.
@ -33,6 +32,22 @@ The server currently needs the following templates to work:
* welcome_runner.html
* welcome_runner.txt
| Name | Type | Default | Description
| - | - | - | -
| APP_PORT | Number | 4010 | The port the backend server listens on. Is optional.
| NODE_ENV | String | dev | The apps env - influences debug info.
| API_KEY | String(min length: 64) | Random generated string | The api key you want to use for auth (query-param `key`), has to be at least 64 chars long.
| API_URL | String(url) | "http://localhost:8080" | The URL ponting to the base (root) of the lfk runner system.
| MAIL_SERVER | String(FQDN) | None | The mailserver (smtp) used to send mails via nodemailer.
| MAIL_PORT | Number | 25 | The mailserver's port (smtp).
| MAIL_USER | String | None | The username used to authenticate against the mailserver.
| MAIL_PASSWORD | String | None | The password used to authenticate against the mailserver.
| MAIL_FROM | String | None | The mail address that mails get sent from.
| PRIVACY_URL | String | "/privacy" | The url path that get's attached to the app url to link to the privacy page.
| IMPRINT_URL | String | "/imprint" | The url path that get's attached to the app url to link to the imprint page.
| COPYRIGHT_OWNER | String | "LfK!" | Text that gets inserted as the "copyright by" owner in the mails.
| EVENT_NAME | String | "Testing 4 Kaya" | The event's name - used to generate the mail text.
| CONTACT_MAIL | String(email) | MAIL_FROM | Contact mail address listed at the bottom of some mail templates.
## Recommended Editor