From 01d4f8b8f8ac84d9420684a80aa9a2162ae2c94d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=BCller?= Date: Sun, 24 Sep 2017 10:47:51 +0200 Subject: [PATCH] README extended --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8cc5cdd..5a1f97f 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,18 @@ Dead simple hosting for markdown notes. ## Running -Install `dep` using Homebrew and run it inside project to install the dependencies: `dep ensure`. +1. Install `dep` using Homebrew and run it inside project to install the dependencies: `dep ensure`. +2. Create a data base by running `make db`. +3. Run the app with `make run`. -Now you can run the app with `make run`. +### ENV variables used: +- For emailing of report abuse: + - `SMTP_SERVER`: + - `SMTP_USER` + - `SMTP_PASSWORD` + - `NOTEHUB_ADMIN_EMAIL` +- Recaptcha secret: + - `RECAPTCHA_SECRET` +- Debugging: + - `SKIP_CAPTCHA` (expected to be non-empty)