From 356271141519807b09b07c8756fadb9f1e5e13e7 Mon Sep 17 00:00:00 2001 From: John Lees-Miller Date: Sat, 27 Oct 2018 17:38:05 +0100 Subject: [PATCH] Add notes on environment variables --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index be2f606..493cf7a 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,10 @@ You can of course customize everything, but here are some places to start: - [`app/views/welcome`](app/views/welcome) — the home page content +- [`development.env`](development.env.template) — [environment variables](#Environment-Variables) in development + + - set emails and other secrets that should not be checked in + - [`public/wedding.ics`](public/wedding.ics) — the calendar invite - this is just a sample file; you probably want to [generate one](https://apps.marudot.com/ical/) @@ -115,7 +119,18 @@ You can of course customize everything, but here are some places to start: $enable-rounded: false; ``` -## Default photo credits +## Environment Variables + +- `CANONICAL_URL` — your website's domain, e.g. `www.mywedding.com` +- `CONTACT_EMAIL` — email address users can use to contact you, e.g. `info@mywedding.com` +- `FROM_EMAIL` — email address emails will come from + +### ReCAPTCHA + +If set, the website will use an invisible reCAPTCHA to prevent spam. You can get these from [Google reCAPTCHA's admin page](https://www.google.com/recaptcha/admin). Be sure to choose "Invisible" for the type. + +- `RECAPTCHA_SITE_KEY` — the `data-sitekey` for the Client side integration +- `RECAPTCHA_SECRET_KEY` — the `secret` for the Server side integration - https://www.pexels.com/photo/selective-focus-photography-of-two-penguins-689784/ - https://www.pexels.com/photo/cold-glacier-iceberg-melting-48178/