Link Search Menu Expand Document
Mailway

Getting Started

Table of contents

  1. Supported platform
  2. Installation
    1. Add the Debian repository
  3. Install Mailway
  4. Setup
    1. Connected mode
      1. Demo
    2. Local mode
  5. Installation with Docker
    1. Connected mode
    2. Local mode

Supported platform

Currently only Ubuntu 20.04 with systemd is officially supported.

Installation

Add the Debian repository

Add the repository:

$ curl -s https://apt.mailway.app/ubuntu/KEY.gpg | sudo apt-key add -
$ sudo curl -s -o /etc/apt/sources.list.d/mailway.list https://apt.mailway.app/ubuntu/mailway.list
$ sudo apt update

Install Mailway 

$ sudo apt install mailway

This will install Mailway and all its components.

Setup

Mailway can operate in two modes:

Connected mode

Connected mode is simpler to setup and allows to configure the routing rules using the Mailway dashboard:

$ mailway setup

Demo

Once the setup is completed, the service will automatically start.

Local mode

Local mode is a standalone email service and doesn’t require communicating with Mailway online services:

$ mailway setup --local

See how to Configure local routing rules.

Installation with Docker

Connected mode 

docker run \
    -p 25:25 -p 80:80 -p 443:443 \
    -v /etc/mailway:/etc/mailway \
    -v /var/log/mailway:/var/log/journal \
    mailway/mailway

Local mode 

docker run \
    -p 25:25 \
    -v /etc/mailway:/etc/mailway \
    -v /var/log/mailway:/var/log/journal \
    -e MW_HOSTNAME=example.com \
    -e MW_EMAIL=[email protected] \
    mailway/mailway-local

Environment variables:

  • MW_HOSTNAME: email server hostname (example: mx.example.com).
  • MW_EMAIL: email used for TLS certificates.