diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md index 254551641..c3fa75e6b 100644 --- a/docs/en/SUMMARY.md +++ b/docs/en/SUMMARY.md @@ -14,6 +14,7 @@ * [macOS](getting_started/prerequisites/macos.md) * [Windows](getting_started/prerequisites/windows.md) * [Local installation](getting_started/installation.md) + * [Development Mail Server](getting_started/dev_mailserver.md) * [Production and Test servers](getting_started/servers.md) * [Recomendations](getting_started/recomendations.md) diff --git a/docs/en/getting_started/dev_mailserver.md b/docs/en/getting_started/dev_mailserver.md new file mode 100644 index 000000000..deec2990d --- /dev/null +++ b/docs/en/getting_started/dev_mailserver.md @@ -0,0 +1,51 @@ +# Development Mail Server + +This is a example to how integrate a mailing service with a development environment of Consul. + +In this example we used [Mailgun](https://www.mailgun.com/). + +## Create an account in Mailgun + +![Creating an account in Mailgun](../../img/mailgun-create-account.png) + +* 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/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/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: + +``` 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 + } +``` +* Fill, `address`, `domain`, `user_name`, `password` with your information. The file would look like: + +![development.rb file](../../img/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. \ No newline at end of file diff --git a/docs/es/SUMMARY.md b/docs/es/SUMMARY.md index 5dfecb560..1351877da 100644 --- a/docs/es/SUMMARY.md +++ b/docs/es/SUMMARY.md @@ -14,6 +14,7 @@ * [macOS](getting_started/prerequisites/macos.md) * [Windows](getting_started/prerequisites/windows.md) * [Instalación local](getting_started/installation.md) + * [Servidor local de correo](getting_started/dev_mailserver.md) * [Servidores de prueba y producción](getting_started/servers.md) * [Recomendaciones](getting_started/recomendations.md) diff --git a/docs/es/getting_started/dev_mailserver.md b/docs/es/getting_started/dev_mailserver.md new file mode 100644 index 000000000..4c2e34f20 --- /dev/null +++ b/docs/es/getting_started/dev_mailserver.md @@ -0,0 +1,52 @@ +# Servidor de correo de desarrollo + +Este es un ejemplo de cómo integrar un servicio de correo con un entorno de desarrollo de Consul. + +En este ejemplo usamos a [Mailgun](https://www.mailgun.com/). + +## Crear una cuenta en Mailgun + +![Creando una cuenta en Mailgun](../../img/mailgun-create-account.png) + +* Omita el formulario de tarjeta de crédito +* Y active su cuenta con el enlace enviado por correo electrónico + + +## Configuración del domain +* Ve a la sección domain: +![Mailgun sección domain](../../img/mailgun-domains.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/mailgun-sandbox.png) + +## 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: + +``` 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 + } +``` + +* Rellene, `address`, `domain`, `user_name`, `password` con su información. El archivo se vería así: + +![archivo development.rb](../../img/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. \ No newline at end of file diff --git a/docs/img/development.rb.png b/docs/img/development.rb.png new file mode 100644 index 000000000..3044c5494 Binary files /dev/null and b/docs/img/development.rb.png differ diff --git a/docs/img/mailgun-create-account.png b/docs/img/mailgun-create-account.png new file mode 100644 index 000000000..57e2cda0a Binary files /dev/null and b/docs/img/mailgun-create-account.png differ diff --git a/docs/img/mailgun-domains.png b/docs/img/mailgun-domains.png new file mode 100644 index 000000000..eddb3510a Binary files /dev/null and b/docs/img/mailgun-domains.png differ diff --git a/docs/img/mailgun-sandbox.png b/docs/img/mailgun-sandbox.png new file mode 100644 index 000000000..872867a42 Binary files /dev/null and b/docs/img/mailgun-sandbox.png differ