morph-ua / morphmails Goto Github PK

Morph Mails (Formerly Helium) is an open-source service that relies on Mailgun and can integrate with any possible client. It creates an unlimited amount of random addresses, receives, parses, and sends a minified version of the letter to the user's chat.

• VPS/VDS with public IP
• Docker (recommended)
• PostgreSQL database

• Open your Linux Terminal and run the following command:

docker run \
  -e DATABASE_URL=<your_db_dsn> \
  -e SECRET_KEY=<secret> \
  -p 8080:8080 -d ghcr.io/morph-ua/mails:v1.5.0-amd64 

📝 Note: You can generate the secret using this shell command:

openssl rand -hex 16

• Next steps from the Network Setup section

• Install the latest version of MorphMails for your OS and architecture.
• Unpack the tarball.
• Open your Linux Terminal and run the following command:

DATABASE_URL=<your_db_dns> SECRET_KEY=<secret> ./morph_mails

• Next steps from the Network Setup section

Here is the configuration guide for Mailgun and your VPS or VDS server.

• Login to your Mailgun account and add your custom domain. Follow the instructions on the Mailgun website to connect and verify your domain.
• Open the Receiving tab and create a new route. Set the following settings below:

+ Expression type: Catch All
+ Forward: <your-webhook-url>/sys/parse?token=SECRET_KEY_FROM_ENV
+ Priority: 0

• Host a client for your desired platform. You can find a list of clients here.

Read the contributing guide to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes.

The changelog is regularly updated to reflect what's changed in each new release.

Future plans and high-priority features and enhancements can be found in our roadmap.

This project is licensed under the terms of CC0-1.0.

For details on supported versions and contact details for reporting security issues, please refer to the security policy.