Visão geral do self hosting

Pré-requisitos

• uma conta no GitHub;
• uma conta na AWS.

1. Variáveis de ambiente

O Madmail depende do AWS SES para enviar emails e do SNS para receber o status de cada envio. Além disso, usa Postgres como banco e Redis como fila. Copie o arquivo .env.selfhost.example para .env e preencha os valores.

AWS_ACCESS_KEY_ID=<access-key-id>
AWS_SECRET_ACCESS_KEY=<secret-access-key>

GITHUB_ID="<seu-github-client-id>"
GITHUB_SECRET="<seu-github-client-secret>"

DATABASE_URL="postgres://<usuario>:<senha>@<host>:<porta>/<nome-do-banco>"
REDIS_URL="redis://<usuario>:<senha>@<host>:<porta>"

openssl rand -base64 32

  NEXTAUTH_URL="https://<sua-instancia>"
  NEXTAUTH_SECRET="<seu-segredo>"

2. Subir a aplicação

Qualquer plataforma que rode Docker serve para hospedar a sua instância.

Docker

Siga este guia para preparar a sua instância: Configurar o Docker.

A imagem oficial do projeto open-source está publicada em usesend/usesend no Docker Hub.

3. Escolher a região

Para enviar emails você precisa escolher uma região na AWS. Use a região onde estão os seus destinatários ou onde a instância está hospedada. Na dúvida, use us-east-1.

As regiões disponíveis estão nesta lista da AWS.

No primeiro login, a instância pede a configuração do SES:

• informe a região;
• informe a callback URL, que é a própria URL da aplicação. Ela precisa ser acessível pela Internet: é por ela que chega o status de entrega dos emails;
• não mexa na taxa de envio, ela acompanha automaticamente a da sua conta.

4. Sair do modo sandbox

5. Proxy SMTP (opcional)

O proxy SMTP é um componente opcional que deixa outras aplicações enviarem emails pela sua instância usando SMTP padrão, em vez da API REST. É útil para sistemas legados, clientes de email e qualquer software que só saiba falar SMTP.

Quando usar o proxy SMTP

• sistemas legados que só suportam SMTP;
• clientes de email como Thunderbird, Outlook e Apple Mail;
• aplicações que não têm como integrar com APIs REST;
• softwares de terceiros que exigem configuração SMTP.

Docker Compose

Crie um docker-compose.yml para o servidor SMTP:

name: usesend-smtp-server

services:
  smtp-server:
    container_name: usesend-smtp-server
    image: usesend/smtp-proxy:latest
    environment:
      SMTP_AUTH_USERNAME: "usesend" # usuário da autenticação SMTP
      USESEND_BASE_URL: "https://sua-instancia.exemplo.com" # URL da sua instância

      # Opcional: caminhos dos certificados SSL
      # USESEND_API_KEY_PATH: "/certs/server.key"
      # USESEND_API_CERT_PATH: "/certs/server.crt"

    # Opcional: montar os certificados SSL
    # volumes:
    #   - ./certs/server.key:/certs/server.key:ro
    #   - ./certs/server.crt:/certs/server.crt:ro

    ports:
      - "25:25" # SMTP padrão
      - "587:587" # SMTP com STARTTLS
      - "2587:2587" # porta SMTP alternativa
      - "465:465" # SMTP sobre SSL/TLS
      - "2465:2465" # porta SMTPS alternativa

    restart: unless-stopped

Suba o servidor SMTP:

docker-compose up -d

Configuração SMTP

Para enviar pelo proxy, configure a sua aplicação assim:

• Host: o IP ou domínio do seu servidor;
• Portas: 25, 587 (STARTTLS), 465 (SSL/TLS), 2587 ou 2465;
• Usuário: usesend (ou o valor que você definiu em SMTP_AUTH_USERNAME);
• Senha: a sua chave de API;
• Criptografia: STARTTLS (portas 25, 587, 2587) ou SSL/TLS (portas 465, 2465).

Próximos passos

Está tudo pronto. A partir daqui:

• configure um domínio de envio;
• crie uma chave de API;
• comece a enviar.

Dúvidas sobre self-host são respondidas na comunidade do projeto open-source — canal #self-host no Discord. Não é o suporte da Madmail.