Skip to content

getting-started.md

Latest commit

 

History

History
67 lines (50 loc) · 1.87 KB

getting-started.md

File metadata and controls

67 lines (50 loc) · 1.87 KB
Raw

Installation

NeoMail runs as a long-lived service on a machine that remains online when you expect inbox sync, API access, MCP access, send-later jobs, or AI indexing to work.

Requirements

  • Node.js 20 or newer with npm
  • A macOS or Linux user account that can install packages
  • Reachability from the NeoMail server to each mailbox's IMAP and SMTP hosts
  • Enough disk for synced message cache, attachments, logs, and search indexes

Install NeoMail

npm install -g neomail
neomail install
neomail setup
neomail start

The install command creates the runtime layout under NEOMAIL_HOME, prepares secure runtime defaults in the .env file if needed, and builds the local Flutter web app for /app.

neomail setup writes admin credentials and optional URL settings into the runtime env file. If you do not pass --admin-pass, the CLI generates a secure password and prints it once.

First run

  1. Open http://localhost:3333.
  2. Create the first account.
  3. Open /admin and configure the LLM provider.
  4. Sign in to /app.
  5. Add an IMAP/SMTP account in Settings.
  6. Trigger the first mailbox sync.
  7. Create an API key if you plan to use /api/v1/* or the MCP host.

Runtime locations

  • NEOMAIL_HOME: runtime root
  • NEOMAIL_DATA_DIR: SQLite database, sessions, and server-owned state
  • NEOMAIL_CACHE_DIR: cached artifacts and transient data
  • NEOMAIL_ENV_FILE: runtime environment file

If unset, NeoMail defaults to a ~/.neomail runtime.

Verify the service

neomail status
neomail logs
neomail open app

Use logs on the machine actually running NeoMail. Logs from another computer do not describe the remote server.

Next steps