From 5314100065f24cb0902c1ba207b880016abd300e Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Wed, 3 Mar 2021 18:45:06 +0100 Subject: [PATCH] Added env var docs to readme ref #3 --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a38a752..6c6ca2c 100644 --- a/README.md +++ b/README.md @@ -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