From db58a280b3792b768eb2b1c82a76d9a9836978b1 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Thu, 4 Mar 2021 16:28:13 +0100 Subject: [PATCH] Updated readme env section ref #151 --- README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 51b2d70..b2ba341 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ yarn docs ## ENV Vars > You can provide them via .env file or docker env vars. -> You can use the `test:ci:generate_env` package script to generate a example env (uses [ethereal.email](https://ethereal.email) as the mailserver). +> You can use the `test:ci:generate_env` package script to generate a example env (uses bs data as test server and ignores the errors). | Name | Type | Default | Description | - | - | - | - @@ -64,11 +64,8 @@ yarn docs | POSTALCODE_COUNTRYCODE | String/CountryCode | N/A | The countrycode used to validate address's postal codes | PHONE_COUNTRYCODE | String/CountryCode | null (international) | The countrycode used to validate phone numers | SEED_TEST_DATA | Boolean | False | If you want the app to seed some example data set this to true -| MAIL_SERVER | String | N/A | The smtp server's ip-address/fqdn -| MAIL_PORT | String | N/A | The smtp server's port -| MAIL_USER | String | N/A | The username for sending mails -| MAIL_PASSWORD | String | N/A | The user's password for sending mails -| MAIL_FROM | String | N/A | The from-address for sending mails +| MAILER_URL | String(Url) | N/A | The mailer's base url (no trailing slash) +| MAILER_KEY | String | N/A | The mailer's api key. | IMPRINT_URL | String(Url) | /imprint | The link to a imprint page for the system (Defaults to the frontend's imprint) | PRIVACY_URL | String(Url) | /privacy | The link to a privacy page for the system (Defaults to the frontend's privacy page)