Install
Release status, supported platforms, what each package contains, and how to build Airpost from source today.
No release has been published yet. Until the first vX.Y.Z tag exists, the download, Homebrew, package and install-script commands on this page won’t work. Build from source instead: see Building from source.
Platforms
| Platform | Status |
|---|---|
| macOS, Apple Silicon and Intel | Supported |
| Linux, x86_64 and aarch64 | Supported (packages need glibc 2.31 or newer: Debian 11, Ubuntu 20.04, RHEL 9) |
| Windows | Not supported. There is no Windows build of the engine, and its socket is a Unix socket only. |
Two things you can install
Airpost comes in two parts, installed separately.
The desktop app
Mail, calendar and contacts in a window. It bundles its own engine and the airpost command, which you can link onto your PATH from Preferences > General.
The command-line programs
For machines without the desktop, or to run the engine on its own: airpost, airpost-engine, airpost-mcp, airpost-gateway, and the built web client.
If you only use the desktop app, you don’t need the second part. Install it when you want the engine on a server, on a machine without a display, or managed separately from the app. Interfaces explains what each program does.
Build from source today
You need the Node version in .node-version, Rust (pinned by rust-toolchain.toml), Python 3 and a C/C++ toolchain.
git clone https://github.com/airpost-mail/airpost.git
cd airpost
make setup # npm ci, Python deps, debug Rust builds
make desktop # the app on a sandbox profile in .dev/profile
make mail # optional: fake IMAP and SMTP accounts to test against
make desktop never touches your real profile. make help lists every target. Building from source covers release builds and the command-line programs.
The desktop app, once released
brew install --cask airpost/tap/airpost
--cask is needed because the command-line formula has the same name. You’ll also be able to download Airpost-AppleSilicon.zip or Airpost.zip (Intel) from the release page.
The command-line programs, once released
After installing the command-line programs
airpost engine install # run the engine in the background, started at login
airpost account add you@example.com
airpost status
On a server without a desktop keyring, keep the engine’s secrets in a key file and let your user units run without a login session:
airpost engine install --key-file ~/.config/airpost-engine.key
loginctl enable-linger "$USER"
To serve the web client on the same machine, run airpost gateway install and then airpost gateway pair. See Self-hosting for remote access and TLS, and Install the CLI for more detail.
Uninstalling
airpost uninstall removes every unit Airpost installed for the profile (service plugins, mcp-http, the gateway, the engine) and the airpost link the desktop put on your PATH. Add --purge-profile to also delete the profile (the mail cache, accounts and settings); it asks first unless you pass -y. Data and files lists what lives where.