Skip to content

DreamsHive/cloakmail

Repository files navigation

CloakMail Logo

CloakMail

Self-hosted disposable email service.
Generate temporary email addresses instantly. No sign-up. No tracking. Auto-expiring.

Documentation · Features · Quick Start · License

CI Release GHCR License Stars


Features

  • No authentication required — generate an inbox instantly, no sign-up or login
  • Auto-expiring — all emails and addresses are automatically deleted after a configurable TTL
  • Zero tracking — no cookies, no analytics, no IP logging
  • Built-in SMTP server — receives emails directly, no third-party email provider needed
  • Self-hosted — run on your own infrastructure with full control over your data
  • REST API — fully documented OpenAPI spec with typed endpoints
  • Web UI — Accessible web interface built with SvelteKit and Tailwind CSS
  • Docker-ready — single docker compose up to run the entire stack

Quick Start

Pull and run directly from GitHub Container Registry:

# Create a docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/DreamsHive/cloakmail/main/docker-compose.yml -o docker-compose.yml

# Set your domain
export DOMAIN=yourdomain.com

# Start all services
docker compose up -d

Or use the GHCR images directly:

docker pull ghcr.io/dreamshive/cloakmail-server:latest
docker pull ghcr.io/dreamshive/cloakmail-web:latest

The web UI will be available at http://localhost:5173 and the API at http://localhost:3000.

Environment Variables

Variable Default Description
DOMAIN localhost Email domain for receiving mail
APP_NAME CloakMail App name displayed in the UI
EMAIL_TTL_SECONDS 86400 Time before emails auto-delete
SMTP_PORT 25 SMTP server port
API_PORT 3000 REST API port

See .env.example for all available options.

Documentation

For full setup guides, API reference, and deployment instructions, visit the official documentation at docs.cloakmail.dev.

License

This project is licensed under the MIT License.

About

Self-hosted open-source disposable email service

Topics

Resources

License

Stars

Watchers

Forks

Packages