Update documentation for email sender and delete unused files

Author: Rub21

envs/.env.web.example

@@ -5,20 +5,21 @@
 SERVER_URL=127.0.0.1
 SERVER_PROTOCOL=http
 
-# Mailer settings 
+# Mailer settings for SES - AWS
 MAILER_ADDRESS=email-smtp.us-east-1.amazonaws.com
 MAILER_DOMAIN=osmseed.org
 MAILER_USERNAME=...
 MAILER_PASSWORD=...
 [email protected]
+MAILER_PORT=25
 
-# Mailer settings for gmail, you need to enable "IMAP Access" and  "Allow less secure apps"
+# # Mailer settings for gmail
 MAILER_ADDRESS=smtp.gmail.com
-MAILER_DOMAIN=localhost
+MAILER_DOMAIN=gmail.com
 [email protected]
-MAILER_PASSWORD=abc
+MAILER_PASSWORD=abc...
 [email protected]
-
+MAILER_PORT=25
 
 # Nominatim settings
 NOMINATIM_URL=nominatim-api

images/web/README.md

@@ -2,16 +2,31 @@
 
 The docker container installs dependencies required for the website, checks out the latest openstreetmap-website code from github and sets up config files.
 
-### Configuration
+# Configuration
 
 In order to run this container we need environment variables, these can be found in the following files👇:
 
 - [.env.web.example](./../../.env.web.example)
 - [.env.db.example](./../../.env.db.example)
 
-**Note**: Rename the above files as `.env.web` and `.env.db`
+**Note**: 
+- Rename the above files as `.env.web` and `.env.db`
 
-### Running web container
+### Email configuration
+
+For sending email it is necessary to set the required variables, osm-seed has been tested with gmail and SES-AWS providers - SMTP.
+- Gmail
+    - Use or create an existing email account.
+    - Make sure "IMAP Access" and "Allow less secure apps" are enabled in your account.
+
+- SES AWS 
+    - You have to create verified email or domain in you AWs acount.
+    - Create an SMTP user, it will give you a user and password.
+    - You have to activate SES for production, otherwise you can only send email to verified emails.
+
+Find examples oh how to setup the configuration for each provider at [.env.web.example](./../../.env.web.example)
+
+# Running web container
 
 ```sh
     # Docker compose

images/web/config/action_mailer.rb

@@ -1,8 +1,7 @@
 #!/usr/bin/env bash
 workdir="/var/www"
-
 export RAILS_ENV=production
-# Because we can not set up many env variable sin build process, we are going to process here!
+#### Because we can not set up many env variable in build process, we are going to process here!
 
 #### SETTING UP THE PRODUCTION DATABASE
 echo " # Production DB
@@ -25,10 +24,11 @@ sed -i -e 's/smtp_enable_starttls_auto: false/smtp_enable_starttls_auto: true/g'
 sed -i -e 's/smtp_authentication: null/smtp_authentication: "login"/g' $workdir/config/settings.yml
 sed -i -e 's/smtp_user_name: null/smtp_user_name: "'$MAILER_USERNAME'"/g' $workdir/config/settings.yml
 sed -i -e 's/smtp_password: null/smtp_password: "'$MAILER_PASSWORD'"/g' $workdir/config/settings.yml
-# sed -i -e 's/smtp_port: 25/smtp_port: '$MAILER_PORT'/g' $workdir/config/settings.yml
-sed -i -e 's/email_from: "OpenStreetMap <[email protected]>"/email_from: "'$MAILER_FROM'"/g' $workdir/config/settings.yml
+sed -i -e 's/[email protected]/'$MAILER_FROM'/g' $workdir/config/settings.yml
+[[ -z "$MAILER_PORT" ]] && MAILER_PORT=25
+sed -i -e 's/smtp_port: 25/smtp_port: '$MAILER_PORT'/g' $workdir/config/settings.yml
 
-# Check if DB is already up
+#### CHECK IF DB IS ALREADY UP AND START THE APP
 flag=true
 while "$flag" = true; do
   pg_isready -h $POSTGRES_HOST -p 5432 >/dev/null 2>&2 || continue
@@ -39,13 +39,8 @@ while "$flag" = true; do
     sleep 2
   done &
 
-  # Precompile again, to catch the env variables
-  # rake i18n:js:export assets:precompile --trace
-  # db:migrate
   bundle exec rails db:migrate
-  # Start the delayed jobs queue worker
-  # bundle exec rake jobs:work
-  # Start the app
+  # Start the delayed jobs queue worker and  Start the app
   bundle exec rake jobs:work &
   apachectl -k start -DFOREGROUND
 done