Getting started
Mimeo runs on your own server, and you run it from its web UI, from your coding agent in your manager repo, or both, on the same flows. Start with the software downloads, connect your sending identity, then prepare your content and audience. For a high-level tour before you begin, watch the demo on the Mimeo homepage.
1. Download, install, and sign in
Open the License page in your Mimeo account, register the domain your Mimeo will run on, then download the latest Mimeo and Mimeo Manager ZIPs. Both downloads share one version per release; use the matching pair.
A license covers one installation: one Mimeo on one domain, with one list. That installation can send from several domains and split brands with segments. A fully separate brand, business, list, or client, on its own domain with its own manager repo, needs its own license; add one with Buy another license in the same account, and each license renews support & updates on its own. Staging copies of your installation are free.
- Mimeo is the Rails application. Follow Deploy Mimeo to install it on your own server with HTTPS, persistent storage, and backups. The guide walks through Hatchbox on DigitalOcean and includes a checklist for other Rails hosts. For the building blocks in plain terms, see Run Mimeo on your own server.
- Mimeo Manager becomes your manager repo: the local workspace for managing your instance with an agent such as Claude Code or Codex. Keep this ZIP for step 4; it is not a second application to deploy.
Mimeo is self-hosted, single-tenant software: your installation holds only your data. Your purchase account and your instance login are separate. On your first visit to the app, follow Sign up on the login page to create its owner account. Signup closes once that account exists; afterward, use the credentials you chose.
2. Set up your sending provider and domain
Mimeo manages your audience and automation; a sending provider delivers the mail. Resend is the simplest starting point for a new setup. Postmark is also supported. Create your provider account and verify the domain you will send from, following the Resend guide or Postmark guide.
After signup, the dashboard shows Get set up to send. Follow its checklist or open Settings → Provider to enter the wizard. It walks through the provider, credentials and webhook, senders and required mailing address, then domain connection checks. Saving your senders creates their sending domains automatically—you do not need to add them again afterward.
Follow Set up sending for the steps and DNS records. Finish when every domain is Connected. Later changes belong under Settings → Provider and Settings → Domains & senders; see Domains & senders.
3. Configure media and the subscriber experience
Once a sending domain and sender are connected:
- Open Settings → General → Storage & media before uploading images. Choose Cloudflare R2, Amazon S3, or Built-in (this server's disk), and save. For R2 or S3, then run Check media hosting. Built-in storage needs persistent disk and backups. The media storage guide covers the choices and public image URLs.
- Check the mailing address collected by the wizard under Settings → General → Email footer. Your email layout should include
{{ mailing_address }}and{{ unsubscribe_url }}; see email layouts. - Open Settings → General → Unsubscribe Flows to customize the unsubscribe page, optionally enable subscription preferences, or set a redirect after unsubscribe. Use Preview page to inspect the subscriber experience. See unsubscribe settings before changing its behavior.
4. Connect your manager repo
Extract the matching Mimeo Manager ZIP on the computer where your coding agent runs. Create an API token under Settings → Agents & API → Manager repo, then have your agent follow Your manager repo to set up the repo and connect it to your instance. The wizard's finish screen offers the same token handoff.
Your agent can use the bundled skills to plan a migration, import a CSV, author emails, and review changes before applying them. A manager repo snapshot contains definitions and media—not your people, events, or a complete database backup. Keep server backups separately.
Your agent uses the CLI for file-based changes, MCP for one-off work, and the API for integrations. The web UI remains available for day-to-day work. How it fits together explains when to use each surface.
5. Create and test your first email
Author an email, preview it against a test person, then use Send test to me. Check the delivered message's sender, layout, images, and footer before mailing subscribers. Separately preview the unsubscribe page in settings.
Build the rest as needed, by hand or with your agent:
- Define custom fields under People → Fields for attributes such as plan, company, and source.
- Define a segment — "who should get what," as live rules rather than frozen lists.
- Build a sequence — a welcome series or course: ordered emails with delays.
- Build a flow — automation started by an event, an approaching subscription renewal or ending, or inactivity.
- Add guards — send-time checkpoints that hold, skip or cancel mail when a condition says so.
6. Import or migrate your audience
Before importing active subscribers, bring over the addresses that must not receive email. Then start with a small, engaged cohort and review the results before expanding. Review automations before any import; historical imports are ignored by default, but flows can opt into them.
- Migrating from another email platformSuppressions first, a three-newsletter transition, and a cutover without duplicate sends.
- CSV importMap columns, preserve subscribe dates, preview a batch, and review its report.
- People and suppressionCheck who can receive email and how unsubscribe state is preserved.
7. Connect ongoing subscriber events
Your app, checkout, signup form, and agent tell your Mimeo what happens as events: a person's email, a name for what happened, such as signed_up, and any details. Create an API token under Settings → Agents & API → API tokens, then ask your agent to connect each of them to your Mimeo; the event contract gives it the exact shape.
An event creates or updates the person, records the event, and can trigger flows listening for signed_up. Test with an address you control, then inspect its People timeline. Have your agent check its work against the event contract before connecting production traffic. During a migration, decide which platform owns each signup and automation so both do not send the same email.
What's next. Once people are in and an email exists, the rest opens up: broadcasts for one-offs, reporting to see what happened, and the scheduled queue for what's about to. When a term is unfamiliar, Mimeo terms has all of them.