Update mail server configuration instructions

This commit is contained in:
taitus
2024-09-17 17:17:50 +02:00
parent c267679aeb
commit ff74960ba3
3 changed files with 21 additions and 35 deletions

View File

@@ -23,7 +23,7 @@
* [Manual installation (not recommended)](installation/manual_installation_production.md) * [Manual installation (not recommended)](installation/manual_installation_production.md)
* [Digital Ocean](installation/digital_ocean.md) * [Digital Ocean](installation/digital_ocean.md)
* [Heroku](installation/deploying-on-heroku.md) * [Heroku](installation/deploying-on-heroku.md)
* [Mail Server Configuration](installation/mail_server_configuration.md) * [Mail server configuration](installation/mail_server_configuration.md)
* [Basic configuration](installation/basic_configuration.md) * [Basic configuration](installation/basic_configuration.md)
* [User documentation and guides](installation/documentation_and_guides.md) * [User documentation and guides](installation/documentation_and_guides.md)

View File

@@ -1,26 +1,19 @@
# Mail Server Configuration # Mail server configuration
This is an example of how to integrate a mailing service with Consul Democracy. This is an example of how to integrate a mailing service with Consul Democracy.
In this example we use [Mailgun](https://www.mailgun.com/). ## Get an account from any email provider
## Create an account in Mailgun To configure email in Consul Democracy, you will need:
![Creating an account in Mailgun](../../img/mailserver/mailgun-create-account.png) * The _smtp_address_, which is the address of your email provider's SMTP server (e.g., smtp.yourdomain.com).
* The _domain_, which is the domain name of your application.
* The _user_name_ and _password_, which are the credentials provided by your email provider to authenticate with the SMTP server.
* Skip the credit card form ## Email configuration in Consul Democracy
* And activate your account with the link sent by email
## Domain configuration 1. Go to the `config/secrets.yml` file.
2. On this file, change these lines under the section `staging`, `preproduction` or `production`, depending on your setup:
* 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 Democracy mailing configuration
* 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 ```yml
mailer_delivery_method: :smtp mailer_delivery_method: :smtp
@@ -34,5 +27,5 @@ In this example we use [Mailgun](https://www.mailgun.com/).
:enable_starttls_auto: true :enable_starttls_auto: true
``` ```
* Fill `<smtp address>`, `<domain>`, `<user_name>` and `<password>` with your information 3. Fill `<smtp address>`, `<domain>`, `<user_name>` and `<password>` with your information.
* Save the file and restart your Consul Democracy application 4. Save the file and restart your Consul Democracy application.

View File

@@ -2,25 +2,18 @@
Este es un ejemplo de cómo integrar un servicio de correo con Consul Democracy. Este es un ejemplo de cómo integrar un servicio de correo con Consul Democracy.
En este ejemplo usamos [Mailgun](https://www.mailgun.com/). ## Obtener una cuenta de tu proveedor de correos de confianza
## Crear una cuenta en Mailgun Para poder configurar el correo en Consul Democracy necesitaremos:
![Creando una cuenta en Mailgun](../../img/mailserver/mailgun-create-account.png) * El _smtp_address_, que es la dirección del servidor SMTP de tu proveedor de correos (por ejemplo, smtp.tudominio.com).
* El _domain_, que es el nombre de dominio de tu aplicación.
* Puedes omitir el formulario de tarjeta de crédito * El _user_name_ y _password_, que son las credenciales que tu proveedor de correos te proporciona para autenticarte en el servidor SMTP.
* Y activa tu cuenta con el enlace enviado por correo electrónico
## Configuración del dominio
* 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)
## Configuración del correo en Consul Democracy ## Configuración del correo en Consul Democracy
* Ve al archivo `config/secrets.yml` 1. Ve al archivo `config/secrets.yml`.
* Modifica las líneas en el archivo para configurar el servidor de correo: 2. Modifica las siguientes líneas en la sección de `staging`, `preproduction` or `production`, dependiendo de tu configuración:
```yml ```yml
mailer_delivery_method: :smtp mailer_delivery_method: :smtp
@@ -34,5 +27,5 @@ En este ejemplo usamos [Mailgun](https://www.mailgun.com/).
:enable_starttls_auto: true :enable_starttls_auto: true
``` ```
* Rellena `<smtp address>`, `<domain>`, `<user_name>` y `<password>` con tu información. 3. Rellena `<smtp address>`, `<domain>`, `<user_name>` y `<password>` con tu información.
* Guarda el fichero y reinicia tu aplicación Consul Democracy 4. Guarda el fichero y reinicia tu aplicación Consul Democracy.