Мышеловка

Мышеловка запускает сверхпростой SMTP-сервер, который перехватывает любое отправленное ему сообщение для отображения в веб-интерфейсе.

Отличительной особенностью проекта является многопроектность из коробки. Хорошо подходит для студий, пользуемся сами.

Приемущества:

• Простая и понятная установка
• Панель управления проектами и раздельные ящики

Возможности:

• Перехватывает всю почту и сохраняет её для отображения
• Пoказыает HTML, обычный текст и заголовки в популярном интерфейсе roundcube
• Поддерживает вложения
• Поддерживает SSL let’s Encrypt из коробки
• Поддерживает WebSocket для проверки почты без перезагрузки страницы

Как установить

• Установите docker и docker-compose

• Склонируйте репозиторий

    git clone git@gitflic.ru:freematiqllc/myshelovka.git
  

• Раздайте права на запись всем в директорию ./data/mails

    chmod -R 777 ./data/mails
  

• Скопируйте файл примера окружения .env.example в .env

    cp .env.example .env
  

• Установите необходимые значения переменных окружения .env

  • Если необходим SSL, то установить USE_SSL=1
  • Если собственные ssl сертификаты, то разместите их в директорию ./data/ssl/real (cert.pem key.pem)
  • Если нужно чтобы выписался автоматический ssl сертификат letsencrypt, то обязательно установите CERTBOT_EMAIL

Запуск:

docker-compose up -d

Скриншоты админки

Консольные команды:

• Получить список пользователей:

    ./ctl_list_user.sh
  

• Создание пользователя:

    ./ctl_create_user.sh email@domain
  

• Смена пароля пользователя:

    ./ctl_change_password_user.sh email@domain
  

• Удаление пользователя:

    ./ctl_delete_user.sh email@domain
  

Подробное описание переменных окружения:

• SERVER_NAME - доменное имя, где записи типа A направлены на IPv4 сервера
• CERTBOT_EMAIL - значение email обязательно для получения сертификата Let’s Encrypt
• ADMIN_APP_TITLE - Заголовок окна браузера для веб приложения
• ADMIN_URL - Маршрут до администратовного раздела приложения. Например если нужно получить административный раздел example.com/admin, то в настройках окружения необходимо установить значение admin
• ADMIN_USER - логин администратора в административном разделе приложения
• ADMIN_PASSWORD - пароль администратора в административном разделе приложения
• POSTGRESS_PASSWORD - пароль к базе данных
• USE_SSL - флаг принимает значения 1 или 0
• HTTP_PORT - порт http доступа до приложения
• HTTPS_PORT - порт https доступа до приложения, не рекомендуется менять
• SMTP_PORT - не шифрованный порт SMTP
• SMTP_TLS_PORT - TLS порт SMTP
• SMTP_SSL_PORT - SSL порт SMTP
• IMAP_PORT - IMAP порт для подключения сбора писем для почтовых программ
• POP3_PORT - POP3 порт для подключения сбора писем для почтовых программ