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
  • Caddy reverse proxy
  • Upgrade script to upgrade EmailEngine in the future (/opt/upgrade-emailengine.sh)
$ wget https://raw.githubusercontent.com/postalsys/emailengine/master/install.sh
$ chmod +x install.sh
$ sudo su
$ ./install.sh example.com

Where

  • example.com is the domain name for EmailEngine. If you do not provide this value, then the install script will ask for it.

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.

CapRover

CapRover has native support for EmailEngine. To install it, open the "One-click apps" gallery in your CapRover installation and search for EmailEngine.

  1. From the setup form, fill in the app's name. Set it, for example, to "emailengine".

  2. Once EmailEngine has been installed, make sure to enable HTTPS. Additionally, check the "Force HTTPS by redirecting all HTTP traffic to HTTPS" checkbox.

  3. Next, click on the application URL to open EmailEngine.

Other platforms

Step 1. Install Node.js runtime

Get Node.js runtime for your platform from here.

Step 2. Download and run EmailEngine

Download and extract application files

$ wget https://github.com/postalsys/emailengine/releases/latest/download/source-dist.tar.gz
$ tar xzf source-dist.tar.gz
$ rm source-dist.tar.gz

Prepare configuration by creating a dotenv file with example values (see all configuration options here).

$ echo 'EENGINE_WORKERS=2
EENGINE_REDIS="redis://127.0.0.1:6379/8"' > .env

Start the app. Configuration is loaded from the dotenv file

$ node server.js