Set up EmailEngine

Installation instructions

All the following examples run EmailEngine with the default configuration. In most cases, you probably want to use specific settings, e.g., to change the Redis connection string. You can read about all the possible configuration options from the configuration page.

MacOS

1. Redis

Install Redis using Homebrew

$ brew update
$ brew install redis
$ brew services start redis

2. EmailEngine

Download emailengine.pkg and run the installer. emailengine executable is installed to /usr/local/bin folder.

3. Start the app

$ emailengine

Linux

1. Redis

Install Redis from the RedisLabs repository

These specific instructions apply to Ubuntu. See other options from the Redis homepage.

$ sudo apt-add-repository -y ppa:redislabs/redis
$ sudo apt-get update
$ sudo apt-get -q -y install redis-server
$ sudo systemctl enable redis-server
$ sudo systemctl start redis-server

2. EmailEngine

Download the compressed emailengine.gz executable, extract it and store it in a suitable location.

$ wget https://github.com/postalsys/emailengine/releases/latest/download/emailengine.tar.gz
$ tar xzf emailengine.tar.gz
$ rm -rf emailengine.tar.gz
$ sudo mv emailengine /usr/local/bin

3. Start the app

$ emailengine

Ubuntu / Debian

You can use the included install script to set up:

  • EmailEngine as a SystemD service
  • Redis server
  • Nginx reverse proxy
  • ACME.sh and Let's Encrypt HTTPS certificate
$ wget https://raw.githubusercontent.com/postalsys/emailengine/master/install.sh
$ chmod +x install.sh
$ sudo su
$ ./install.sh example.com info@example.com

Where

  • example.com is the domain name for EmailEngine
  • info@example.com is your email address to generate the HTTPS certificate

NB! Tested with Ubuntu 20.04 and Debian 11. Might not work with other OS versions. Must be run as root.

Windows

1. Redis

There is no official build of Redis for Windows. You can install a compatible alternative like Memurai or configure EmailEngine to use a remote Redis instance.

2. EmailEngine

Download emailengine.exe executable and store it in a suitable location.

3. Start the app

In PowerShell, run the executable:

PS C:\Users\user\Downloads> emailengine.exe

DigitalOcean

EmailEngine is available on the DigitalOcean Marketplace as a 1-Click Application. When spinning up the application, you can choose either the included Redis instance or the managed DB option. If you do not choose the managed option, you are responsible for backups yourself.

The following link is a referral link that gives you free credit if you are not yet a DigitalOcean customer.

Heroku

Use the "Deploy to Heroku" button to set up and run EmailEngine on Heroku. You only have to set the name value on the application configuration form; other fields can be left as is.

Deploy

Render

Use the "Deploy to Render" button to set up and run EmailEngine on Render.

Deploy to Render

See manual installation instructions for Render.com here.