From 45449f5556f17d5cc02d47fa5b0c257d28d5f825 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Pimentel=20Ferreira?= Date: Fri, 13 Nov 2020 13:15:39 +0100 Subject: [PATCH 1/3] Update dev_mailserver.md Mail server configuration now is done on `config/secrets.yml` and thus documentation should be updated accordingly. --- docs/SUMMARY.md | 2 +- docs/en/installation/dev_mailserver.md | 57 ++++++++++---------------- 2 files changed, 23 insertions(+), 36 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index f1b6a09d8..4a6d6eb47 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -23,7 +23,7 @@ * [Digital Ocean](en/installation/digital_ocean.md) * [Heroku](en/installation/deploying-on-heroku.md) * [Docker](en/installation/docker.md) - * [Development Mail Server](en/installation/dev_mailserver.md) + * [Mail Server Configuration](en/installation/dev_mailserver.md) * [Basic configuration](en/installation/basic_configuration.md) * [CONSUL Documentation and guides](en/installation/documentation_and_guides.md) diff --git a/docs/en/installation/dev_mailserver.md b/docs/en/installation/dev_mailserver.md index 15bc9e78c..cb8cd4a1a 100644 --- a/docs/en/installation/dev_mailserver.md +++ b/docs/en/installation/dev_mailserver.md @@ -1,8 +1,8 @@ -# Development Mail Server +# Mail Server Configuration -This is a example to how integrate a mailing service with a development environment of Consul. +This is an example of how to integrate a mailing service with Consul. -In this example we used [Mailgun](https://www.mailgun.com/). +In this example we use [Mailgun](https://www.mailgun.com/). ## Create an account in Mailgun @@ -11,41 +11,28 @@ In this example we used [Mailgun](https://www.mailgun.com/). * Skip the credit card form * And activate your account with the link sent by email - ## Domain configuration -* Go to the Domains section: -![Mailgun domain section](../../img/mailserver/mailgun-domains.png) -* Since you don't have a domain yet, you should click in the sandbox that is already created; -* Remember the next credentials: -![Mailgun sandbox](../../img/mailserver/mailgun-sandbox.png) +* Go to the Domains section: ![Mailgun domain section](../../img/mailserver/mailgun-domains.png) +* Since you don't have a domain yet, you should click in the sandbox that is already created +* Remember the following credentials: ![Mailgun sandbox](../../img/mailserver/mailgun-sandbox.png) -## Consul mailing configuration for development environment -* Go to `config/environments/development.rb` file; -* Add the lines on the file to configure the mail server: +## Consul mailing configuration -``` ruby - config.action_mailer.delivery_method = :smtp - config.action_mailer.perform_deliveries = true - config.action_mailer.smtp_settings = { - :address => '', - :port => 2525, - :domain => '', - :user_name => '', - :password => '', - :authentication => :plain, - :enable_starttls_auto => true, - :ssl => false - } +* Go to the `config/secrets.yml` file +* Change the lines on the file to configure the mail server under the section `staging`, `preproduction` or `production`, depending on your setup: + +```yml + mailer_delivery_method: :smtp + smtp_settings: + :address: "" + :port: 587 + :domain: "" + :user_name: "" + :password: "" + :authentication: "plain" + :enable_starttls_auto: true ``` -* Fill, `address`, `domain`, `user_name`, `password` with your information. The file would look like: -![development.rb file](../../img/mailserver/development.rb.png) - -## Consul mailing configuration for production environment - -* Go to `config/environments/production.rb` file. -* Add the same **action mailer settings** configuration, but now with your production mail server information. -* Pay attention because you will need to change the **port** number to **587**. - -You can also use Mailgun to production, adding your custom domain. Mailgun’s logs sent and delivered emails. +* Fill ``, ``, `` and `` with your information +* Save the file and restart your Consul application From 7674434943f70cf9321bbb81be69dbc07263a834 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Pimentel=20Ferreira?= Date: Sat, 14 Nov 2020 20:22:42 +0100 Subject: [PATCH 2/3] Rename dev_mailserver.md to mail_server_configuration.md --- docs/SUMMARY.md | 4 ++-- .../{dev_mailserver.md => mail_server_configuration.md} | 0 .../{dev_mailserver.md => mail_server_configuration.md} | 0 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/en/installation/{dev_mailserver.md => mail_server_configuration.md} (100%) rename docs/es/installation/{dev_mailserver.md => mail_server_configuration.md} (100%) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 4a6d6eb47..696a178a4 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -23,7 +23,7 @@ * [Digital Ocean](en/installation/digital_ocean.md) * [Heroku](en/installation/deploying-on-heroku.md) * [Docker](en/installation/docker.md) - * [Mail Server Configuration](en/installation/dev_mailserver.md) + * [Mail Server Configuration](en/installation/mail_server_configuration.md) * [Basic configuration](en/installation/basic_configuration.md) * [CONSUL Documentation and guides](en/installation/documentation_and_guides.md) @@ -75,7 +75,7 @@ * [Digital Ocean](es/installation/digital_ocean.md) * [Heroku](es/installation/deploying-on-heroku.md) * [Docker](es/installation/docker.md) - * [Servidor local de correo](es/installation/dev_mailserver.md) + * [Servidor local de correo](es/installation/mail_server_configuration.md) * [Configuración básica](es/installation/basic_configuration.md) * [Documentación y guías sobre CONSUL](es/installation/documentation_and_guides.md) diff --git a/docs/en/installation/dev_mailserver.md b/docs/en/installation/mail_server_configuration.md similarity index 100% rename from docs/en/installation/dev_mailserver.md rename to docs/en/installation/mail_server_configuration.md diff --git a/docs/es/installation/dev_mailserver.md b/docs/es/installation/mail_server_configuration.md similarity index 100% rename from docs/es/installation/dev_mailserver.md rename to docs/es/installation/mail_server_configuration.md From 0f005c8417be2e0f5fe78a01f89bf6f945875242 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javi=20Mart=C3=ADn?= Date: Wed, 10 Nov 2021 01:41:46 +0100 Subject: [PATCH 3/3] Apply mail configuration changes to Spanish docs --- docs/SUMMARY.md | 2 +- .../installation/mail_server_configuration.md | 62 +++++++------------ 2 files changed, 25 insertions(+), 39 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 696a178a4..2addbbe17 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -75,7 +75,7 @@ * [Digital Ocean](es/installation/digital_ocean.md) * [Heroku](es/installation/deploying-on-heroku.md) * [Docker](es/installation/docker.md) - * [Servidor local de correo](es/installation/mail_server_configuration.md) + * [Configuración del servidor de correo](es/installation/mail_server_configuration.md) * [Configuración básica](es/installation/basic_configuration.md) * [Documentación y guías sobre CONSUL](es/installation/documentation_and_guides.md) diff --git a/docs/es/installation/mail_server_configuration.md b/docs/es/installation/mail_server_configuration.md index 82cae8fab..a42ca859c 100644 --- a/docs/es/installation/mail_server_configuration.md +++ b/docs/es/installation/mail_server_configuration.md @@ -1,52 +1,38 @@ -# Servidor de correo de desarrollo +# Configuración del servidor de correo -Este es un ejemplo de cómo integrar un servicio de correo con un entorno de desarrollo de Consul. +Este es un ejemplo de cómo integrar un servicio de correo con Consul. -En este ejemplo usamos a [Mailgun](https://www.mailgun.com/). +En este ejemplo usamos [Mailgun](https://www.mailgun.com/). ## Crear una cuenta en Mailgun ![Creando una cuenta en Mailgun](../../img/mailserver/mailgun-create-account.png) -* Omita el formulario de tarjeta de crédito -* Y active su cuenta con el enlace enviado por correo electrónico +* Puedes omitir el formulario de tarjeta de crédito +* Y activa tu cuenta con el enlace enviado por correo electrónico +## Configuración del dominio -## Configuración del domain -* Ve a la sección domain: -![Mailgun sección domain](../../img/mailserver/mailgun-domains.png) +* Ve a la sección "domain": ![Mailgun sección domain](../../img/mailserver/mailgun-domains.png) +* Como todavía no tienes un dominio, debes pinchar en el "sandbox" que ya está creado +* Recuerda las siguientes credenciales: ![Mailgun sandbox](../../img/mailserver/mailgun-sandbox.png) -* Como todavía no tienes un domain, debes hacer clic en el sandbox que ya está creado; -* Recuerde las próximas credenciales: -![Mailgun sandbox](../../img/mailserver/mailgun-sandbox.png) +## Configuración del correo en Consul -## Configuración de correo del Consul para el entorno de desarrollo -* Vaya al archivo `config/environments/development.rb`; -* Agregue las líneas en el archivo para configurar el servidor de correo: +* Ve al archivo `config/secrets.yml` +* Modifica las líneas en el archivo para configurar el servidor de correo: -``` ruby - config.action_mailer.delivery_method = :smtp - config.action_mailer.perform_deliveries = true - config.action_mailer.smtp_settings = { - :address => '', - :port => 2525, - :domain => '', - :user_name => '', - :password => '', - :authentication => :plain, - :enable_starttls_auto => true, - :ssl => false - } +```yml + mailer_delivery_method: :smtp + smtp_settings: + :address: "" + :port: 587 + :domain: "" + :user_name: "" + :password: "" + :authentication: "plain" + :enable_starttls_auto: true ``` -* Rellene, `address`, `domain`, `user_name`, `password` con su información. El archivo se vería así: - -![archivo development.rb](../../img/mailserver/development.rb.png) - -## Configuración de correo de Consul para el entorno de producción - -* Vaya al archivo `config/environments/production.rb`; -* Agregue la misma configuración de **action mailer settings**, pero ahora con su información de servidor de correo de producción. -* Preste atención porque necesitará cambiar el número del **puerto** para **587**. - -Puede usar Mailgun para producción también, agregando su dominio personalizado. Mailgun hay registros (logs) de los correos enviados y entregues. +* Rellena ``, ``, `` y `` con tu información. +* Guarda el fichero y reinicia tu aplicación Consul