Skip to content

notymail/core

Repository files navigation

notymail

GitHub Sponsors

⭐ Features

  • Send emails from any environment

🔧 How to Install

🐳 Docker

docker run -d -p 3124:3124 --restart=always --name notymail \
  -e API_KEYS='' \
  -e MAIL_SENDER='notymail <[email protected]>' \
  -e MAIL_HOST='gmail.com' \
  -e MAIL_PORT='587' \
  -e MAIL_SECURE='false' \
  -e MAIL_AUTH_USER='[email protected]' \
  -e MAIL_AUTH_PASSWORD='password' \
  dafnik/notymail:latest

notymail is now running on http://0.0.0.0:3124.

Alternatively you can use the GitHub Docker Container Registry.

docker run -d -p 3124:3124 --restart=always --name notymail \
  -e API_KEYS='' \
  -e MAIL_SENDER='notymail <[email protected]>' \
  -e MAIL_HOST='gmail.com' \
  -e MAIL_PORT='587' \
  -e MAIL_SECURE='false' \
  -e MAIL_AUTH_USER='[email protected]' \
  -e MAIL_AUTH_PASSWORD='password' \
  ghcr.io/notymail/core:latest

Note

If you want to limit exposure to localhost (without exposing port for other users or to use a reverse proxy), you can expose the port like this:

docker run -d -p 127.0.0.1:3124:3124 --restart=always --name notymail \
-e API_KEYS='' \
-e MAIL_SENDER='notymail <[email protected]>' \
-e MAIL_HOST='gmail.com' \
-e MAIL_PORT='587' \
-e MAIL_SECURE='false' \
-e MAIL_AUTH_USER='[email protected]' \
-e MAIL_AUTH_PASSWORD='password' \
dafnik/notymail:latest

Advanced Installation

If you need more options or need to browse via a reverse proxy, please read:

https://notymail.dafnik.me/getting-started/installation

🆙 How to Update

https://notymail.dafnik.me/getting-started/update

Motivation

  • Needed an easy way to send emails from CIs.
  • Wanted a somewhat secure solution with api keys.
  • Wanted to build something with hono/js.

Liking this project? please consider giving it a ⭐.