Installation

This guide covers the different ways to install and run CloakMail.

Prerequisites

Before installing CloakMail, ensure you have:

• Docker and Docker Compose (recommended method)
• A domain with MX records pointing to your server (for receiving emails)
• Port 25 accessible for SMTP traffic

Docker Installation (Recommended)

The easiest way to run CloakMail is with Docker:

1. Clone the Repository

git clone https://github.com/DreamsHive/cloakmail.git
cd cloakmail

2. Configure Environment

cp .env.example .env

Edit .env with your settings:

# Your email domain
DOMAIN=mail.example.com

# Application name shown in UI
APP_NAME=CloakMail

# Email expiration time (in seconds)
EMAIL_TTL_SECONDS=3600

# Server ports
SMTP_PORT=25
API_PORT=3000

3. Start the Services

docker compose up -d

Using Pre-built Docker Images

You can also use the pre-built images from GitHub Container Registry:

# Pull the images
docker pull ghcr.io/dreamshive/cloakmail-server:latest
docker pull ghcr.io/dreamshive/cloakmail-web:latest

DNS Configuration

For CloakMail to receive emails, configure your domain's DNS:

MX Record

Type: MX
Host: @
Value: mail.example.com
Priority: 10

A Record

Type: A
Host: mail
Value: YOUR_SERVER_IP

Verify Installation

1. Open http://localhost:5173 in your browser
2. Generate a new inbox
3. Send a test email to the generated address
4. Check that the email appears in the inbox

Next Steps

• Quick Start — Create your first inbox
• Docker Configuration — Advanced Docker settings
• Environment Variables — Full configuration reference