From a1c76a23be196c341ac03c2b290704b80750d163 Mon Sep 17 00:00:00 2001 From: Kayne Ruse Date: Thu, 4 Feb 2021 02:19:39 +1100 Subject: [PATCH] Updated README.md --- .envdev | 2 +- README.md | 13 ++++++++++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.envdev b/.envdev index 8ba1f5d..4553071 100644 --- a/.envdev +++ b/.envdev @@ -6,7 +6,7 @@ MAIL_SMTP=smtp.example.com MAIL_USERNAME=foobar@example.com MAIL_PASSWORD=foobar -DB_HOSTNAME=127.0.0.1 +DB_HOSTADDR=127.0.0.1 DB_DATABASE=template DB_USERNAME=template DB_PASSWORD=pikachu diff --git a/README.md b/README.md index daae09e..ba5ac30 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ This should get the template working in development mode. # Deployment -When deploying your project, please ensure that you're using HTTPS protocol. It's not hard to set up using certbot. +When deploying your project, please ensure that you're using HTTPS protocol. It's not hard to set up using [certbot](https://certbot.eff.org/). # Microservices @@ -51,6 +51,17 @@ TODO: more info. - Direct Messages & rooms - admin panel banning/unbanning (currently borked) - Privacy policy & data collection notice +- configuration script +- Docker, docker, docker. +- Start here page + +Eventually, a clean install will be this easy: + +``` +git clone template-url +npm run configure +npm start +``` # Email settings