Getting Started

Quick Deploy

Go from zero to a fully working Cleanmails instance in under 10 minutes. No coding required — just a VPS and your license key.

What is a VPS?

A VPS (Virtual Private Server) is a computer that stays on 24/7 in a data center. Instead of running Cleanmails on your laptop, you run it on a VPS so it can handle thousands of emails while you sleep.

Recommended VPS Providers

We recommend Contabo, Hetzner, or DigitalOcean. Choose a plan with at least 4GB RAM and Ubuntu 22.04 as the operating system.

Step-by-Step Setup

1

Get your VPS & connect via SSH

Purchase a VPS with Ubuntu 22.04. You'll receive an IP address and root password.

Windows users: Download Putty, enter your VPS IP, click Open, login as root.

Mac/Linux users: Open Terminal and run:

bash
ssh root@YOUR_VPS_IP
How to paste in terminal

In most terminals (Putty, etc.), you don't use Ctrl+V. Just right-click inside the terminal window to paste.

2

Request Port 25 unblock

Before installing, contact your VPS provider to unblock outbound port 25. This is required for email validation and sending.

ProviderHow to Unblock
HetznerSubmit a support ticket — usually approved in <1 hour
VultrSubmit a support ticket via the portal
DigitalOceanSubmit a support ticket — may require account age
ContaboSubmit a support ticket
AWS EC2Fill out the PTR/rDNS form in the console

Test if port 25 is open:

bash
nc -zv gmail-smtp-in.l.google.com 25
3

Run the installer

Use the command generator below to create your personalized install command, then paste it into your terminal.

Auto-Deploy

Installation Command Generator

Fill in your details to generate a one-click installation command with automatic SSL.

Terminal
curl -sSL https://cleanmails.online/install.sh | bash -s -- --key {LICENSE_KEY} --domain {YOUR_DOMAIN}

rDNS Configuration

Set your server's Reverse DNS (PTR) record to: {YOUR_DOMAIN}

The installer will:

  1. Update system packages and install Docker
  2. Configure the firewall (ports 22, 80, 443, 25, 587, 465, 993)
  3. Generate a secure master encryption key
  4. Detect your server's public IP
  5. Deploy Cleanmails + Caddy + Mail Server via Docker Compose
  6. Auto-provision SSL certificate (if domain is pointed)
4

Point your domain

Create an A record pointing your domain to your VPS IP address:

TypeNameValue
Aapp (or @)YOUR_VPS_IP
5

Set Reverse DNS (rDNS/PTR)

Go to your VPS provider's control panel and set the PTR record to your domain. This is critical for email deliverability.

6

Complete the setup wizard

Open your domain in a browser. You'll see the initialization page where you create your admin account.

Save your password!

There is no "Forgot Password" button because your data is private and self-hosted. Write down your admin credentials.

What's Next?