Update outdated information

This commit is contained in:
Miguel Nogueira 2020-07-09 08:53:56 +01:00
parent c3a6b16a13
commit 635f8593d3
1 changed files with 16 additions and 40 deletions

View File

@ -65,34 +65,10 @@ Tech stack:
# Installation
Make sure all prerequisites are installed. Afterwards, clone this repository, make ``install.sh``executable and run it.
Note that this script will change the database credentials to Vagrant's defaults, so if you're not using Vagrant, make sure to edit the ``.env`` file with your database settings.
# Configuration
This app requires other configuration parameters:
- Google Recaptcha - [create captcha key pair](https://www.google.com/recaptcha/admin/create)
- IP Geolocation API Key - [get your key here](https://ipgeolocation.io/signup.html)
- SMTP Server and Email account (for email notifications)
- Slack integration webhook URL (create an application in Slack Dev Center - Check webhook docs)
These configuration settings are fairly self explanatory, but here's a list of what you need to fill on the ``.env`` file:
``RECAPTCHA_SITE_KEY``
``RECAPTCHA_PRIVATE_KEY``
``IPGEO_API_KEY``
``MAIL_PORT``
``MAIL_HOST``
``MAIL_USERNAME``
``MAIL_PASSWORD``
And the database settings, located at the top.
This process will be later streamlined with a web installer.
Configuration is currently done via the installer. Alternatively, you may also edit the ``.env`` file directly.
This process will be moved to the browser later.
# Bug reports