Admin guide
This guide covers the administration of a Mailr server: installing, configuring, securing, backing up and upgrading the stack, and the admin screens inside the app.
An admin manages users, model endpoints and instance policies. Every user, admin or not, manages only their own mail accounts, labels, rules and tokens. No user can see another user's mail.
Install and run
| Page |
Topics |
| Deployment |
The services, ports, volumes and resources of the stack. |
| Scaling |
How the work is shared between users, model call limits, more workers and sizes of server. |
| Configuration |
Every setting in .env, grouped by topic. |
| Reverse proxy |
HTTPS in front of Mailr, with Caddy, nginx and Traefik examples. |
| Upgrades |
New versions, migrations and pinned images. |
| Backups |
The parts to back up, the daily export, the backup target and restores. |
Users and sign-in
Mail
| Page |
Topics |
| The mail server |
The bundled Stalwart server, IMAP, TLS and spam checks. |
| Account modes |
Keep in sync, Mailr keeps the mail and Copy once, and turning on deletion at the provider. |
| Image proxy and VPN egress |
Remote images in mail, trackers and an optional VPN exit. |
Features
| Page |
Topics |
| Models |
Model endpoints, models per task, local-only mail and embeddings. |
| Web search |
Search providers, page readers and the browser in the stack. |
| Built-in calendars |
A calendar and a task list for every user on Mailr's own server, and access from phones and computers. |
| Phone apps |
Publishing the Android apps' APKs, which are downloaded to phones from the server. |
| Push notifications |
ntfy and UnifiedPush for phones, Web Push for browsers. |
| Dictation server |
A self-hosted speech-to-text server for dictation. |
| Languages |
The languages of the app and of this guide, and adding a translation. |
Operations