Skip to content

armgit / fider

Public Imported from GitHub
0

Open platform to collect and prioritize feedback

docs: update Fider requirements on email settings (#563)

Guilherme Oenningef9a1c298fa1
diff --git a/.example.env b/.example.env
index db5a9000d..d4878a71e 100644
--- a/.example.env
+++ b/.example.env
@@ -14,12 +14,12 @@ OAUTH_GOOGLE_SECRET=
OAUTH_GITHUB_CLIENTID=
OAUTH_GITHUB_SECRET=
-EMAIL_NOREPLY=null
EMAIL_MAILGUN_API=
EMAIL_MAILGUN_DOMAIN=
-EMAIL_SMTP_HOST=null
-EMAIL_SMTP_PORT=null
+EMAIL_SMTP_HOST=smtp.yourdomain.com
+EMAIL_SMTP_PORT=587
EMAIL_SMTP_USERNAME=
EMAIL_SMTP_PASSWORD=
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 42aa7545e..dc620eaf0 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -36,6 +36,8 @@ To setup your development workspace:
5) run `mage watch` to start the application.
6) Navigate to `http://localhost:3000/` and 🎉! You should see the sign up page of Fider!
+**Important:** Fider has a strong dependency on an email delivery service. You'll need to edit `.env` file and configure the `EMAIL_*` environment variables with your own SMTP server details. If you don't have an SMTP server, you can either sign up for a [Mailgun account](https://www.mailgun.com/) (it's Free) or sign up for a [Mailtrap account](https://mailtrap.io), which is a free SMTP mocking server. If you prefer not to setup an email service, keep an eye on the server logs. Sometimes it's necessary to navigate to some URLs that are only sent by email, but are also written to the logs.
+
To run the unit tests:
1) run `docker-compose up -d pgtest` to start a test-only PostgreSQL database on Docker.