VoidMail Documentation Installation and operations guide

Installation guide for VoidMail

VoidMail is a self-hosted temporary email platform with a public disposable inbox, receive-only mail routing, domain onboarding, IMAP fetch tooling, a Mail Health Center, and a full admin surface for day-one operations.

Recommended target Clean Ubuntu 24.04 LTS VPS with root or sudo access.
Provisioned stack Nginx, PHP 8.4, MariaDB, Redis, Postfix, PowerDNS, Certbot, and phpMyAdmin.
Finish step The installer ends with a one-time setup link to create the first admin account.
Current installer path: the supported production path is the signed CLI bootstrap from install.voidmail.email, followed by the guided installer on the target VPS.

Requirements

VoidMail is designed for a clean Ubuntu VPS where the installer can provision the web, mail, DNS, queue, and SSL stack without having to work around an existing shared mail configuration.

Category Current requirement Notes
Operating system Ubuntu 24.04 LTS recommended, Ubuntu 22.04 LTS accepted The runtime is opinionated around Ubuntu LTS and rejects non-Ubuntu targets.
Minimum resources 1.5 GB RAM and 5 GB free disk Use a larger VPS if you expect sustained inbox traffic or larger attachments.
Access Root or sudo access, public IP, domain, and valid license key The installer needs package management, service control, and filesystem access.
App package Laravel bundle with compiled frontend assets in public/build Production installs should not depend on npm being present on the target server.

Packages provisioned by the installer

  • Nginx with PHP 8.4 FPM and CLI.
  • MariaDB, Redis, Composer, Certbot, and system utilities.
  • Postfix for receive-only mail flow.
  • PowerDNS and DNS utilities for domain management.

Before you start

  • Point the main production domain to the target server.
  • Open the firewall ports listed below.
  • Prepare the buyer email used for SSL and operational notices.
  • Keep the VoidMail license key ready during installation.

Firewall ports to allow

VoidMail is not only a Laravel app. The production runtime also expects public web access, DNS service, and inbound SMTP delivery. Open the following ports before testing live traffic.

Port Purpose Required
80/tcp HTTP for the site and SSL challenge flow Yes
443/tcp HTTPS for the public site and admin panel Yes
25/tcp Inbound SMTP for receive-only mail routing Yes
53/tcp + 53/udp Authoritative DNS when PowerDNS is managing zones Yes for DNS-managed deployments
Important: if the server provider blocks port 25 or port 53, VoidMail can install but real mail delivery or live DNS delegation will not work end to end.

Installation steps

The install flow is built around a signed CLI bootstrap. Buyers download the CLI, run the guided installer on the VPS, and complete the first-admin setup in the browser when infrastructure is ready.

curl -fsSL https://install.voidmail.email/install.sh | bash

voidmail
1
Bootstrap the installer CLI

Run the install script from install.voidmail.email. It fetches the signed CLI build, verifies the checksum, and installs the voidmail command.

2
Run the guided installer on the VPS

Start voidmail, provide the domain, license, and deployment details, and let the runtime provision Nginx, PHP, MariaDB, Redis, Postfix, PowerDNS, SSL tooling, scheduled jobs, and the Laravel app.

3
Open the one-time admin setup link

At the end of installation, the runtime prints a one-time setup URL. Open that link immediately, create the first admin user, and sign in to the admin panel.

4
Validate the core services

After sign-in, review domains, IMAP settings if used, Health Center, cleanup settings, and the public inbox flow. Test mailbox generation, message receive flow, and attachment downloads before launch.

Useful commands after install

voidmail doctor
voidmail status
voidmail logs --install

What the installer wires

  • Environment file and Laravel app configuration.
  • Database, migrations, storage permissions, and services.
  • Web server and SSL flow.
  • Mail ingest, cleanup cadence, and DNS sync tasks.

How to use

Once the installer is complete, VoidMail has two primary surfaces: the public disposable inbox and the admin panel. Buyers typically validate both during initial setup.

Public workflow

  • Generate a mailbox from the homepage or refresh an existing one.
  • Copy the address and use it anywhere you need a temporary inbox.
  • Poll for messages, open individual messages, and download attachments.
  • Delete the mailbox or rotate to a new address when done.

Admin workflow

  • Add the active domain and mark the default receiving domain.
  • Configure IMAP if you are using fetch-based mail retrieval.
  • Check Health Center after DNS, SSL, or mail changes.
  • Control cleanup, pages, ad slots, and support settings from the admin panel.

Core functions

The current codebase already implements the real operational shape of the product rather than only a landing page mock. The main functions below are already present in the app and installer flow.

Instant mailbox generation

  • Creates disposable inboxes on demand.
  • Supports alias and expiry rules.
  • Can protect inbox access with a token instead of exposing open state by default.

Public inbox API and UI

  • Mailbox polling and refresh flow.
  • Message list, message detail, and deletion endpoints.
  • Attachment download handling.

Mail ingestion

  • Receives mail through the VPS runtime.
  • Resolves the target mailbox and stores the message safely.
  • De-duplicates incoming mail and sanitizes HTML before display.

IMAP fetch mode

  • Stores IMAP credentials and tests connectivity.
  • Tracks fetch status and fetch recency.
  • Supports manual fetch execution from the admin panel.

Admin panel

The admin UI already covers the operating surface needed to run the platform, not just a placeholder dashboard.

Core admin areas

  • Dashboard with platform stats and recent activity.
  • Domain management and default-domain control.
  • IMAP settings and fetch controls.
  • Mailbox and message management.

Business and content controls

  • Static page content and SEO settings.
  • Ads management for monetized placements.
  • PWA, theme, security, and general settings.
  • Admin user management and system tools.

Health Center

The Mail Health Center is one of the practical differentiators in VoidMail. It is built to reduce support friction by surfacing the state of the runtime in one place.

What it checks

  • PHP and database connectivity.
  • Storage state and queue mode.
  • HTTPS availability.
  • IMAP extension, IMAP login, and fetch recency.

Why it matters

  • Speeds up post-install validation.
  • Helps buyers identify missing DNS or mail setup quickly.
  • Provides support-friendly status output during troubleshooting.

Operations

Operational work after launch is mostly centered on inbox hygiene, domain state, IMAP status, and service health. VoidMail already exposes the main controls needed for routine maintenance.

Routine tasks

  • Review Health Center after DNS, SSL, or mail-routing changes.
  • Confirm the default receiving domain is correct.
  • Run manual IMAP fetch when diagnosing delayed polling.
  • Check cleanup settings for mailbox and message retention.

Useful admin tools

  • Clear cache from the system tools area.
  • Export and import settings backups.
  • Inspect recent mailboxes and stored messages.
  • Verify ad slots and content pages before marketing launch.

Troubleshooting

Most initial support issues come from one of four areas: firewall exposure, DNS delegation, SMTP delivery, or an incomplete installer run.

First checks

  • Confirm ports 80, 443, 25, and 53 are publicly reachable where required.
  • Check the active domain DNS and SSL state.
  • Open Health Center and review the failed checks first.
  • Use voidmail doctor and voidmail status for runtime clues.

If mail is not appearing

  • Verify the receiving domain is pointed correctly.
  • Check whether the server provider allows inbound SMTP on port 25.
  • Review IMAP configuration if using fetch mode.
  • Inspect recent messages and fetch timestamps in the admin panel.

FAQ

Which Ubuntu version should buyers use?

Ubuntu 24.04 LTS should be the documented production target. Ubuntu 22.04 LTS is still accepted by the current runtime checks.

Does VoidMail include the admin panel already?

Yes. The admin UI is already wired for dashboard, domains, IMAP, Health Center, settings, mailboxes, messages, ads, cleanup, and system tools.

Does the installer configure mail and DNS services?

Yes. The current production installer provisions Postfix and PowerDNS as part of the runtime path on the target VPS.

Can buyers run VoidMail without npm on production?

They should not need to. The distributed app bundle should already include compiled frontend assets.

Changelog

Current release direction

  • Installer path centered on the signed CLI bootstrap.
  • Production docs aligned to Ubuntu 24.04, live ports, and real admin features.
  • Standalone documentation site and matching domain network for marketing, demo, install, and status.

Contact us

If a buyer needs installation help, runtime troubleshooting, or pre-purchase clarification, use the contact details below.