inbuxa/ihasmail-inbuxa
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request #344 from Coffey-Labs/docs/companion-tools

Browse Source 
Point to the companion tools near the top of the README
This commit is contained in:
jcoffey
2026-09-13 22:48:01 -07:00
committed by GitHub
parent c587268c97 9647ead8d4
commit 1dc0caeae9
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14
View File
@@ -33,6 +33,16 @@ durable belongs to Stalwart; the container is disposable.
| 🧪 **[KNOWN-ISSUES.md](KNOWN-ISSUES.md)** | What was verified live, and where Stalwart departs from a spec | | 🧪 **[KNOWN-ISSUES.md](KNOWN-ISSUES.md)** | What was verified live, and where Stalwart departs from a spec |
| 🛣 **[ROADMAP.md](ROADMAP.md)** | What ihasmail does not do, and why | | 🛣 **[ROADMAP.md](ROADMAP.md)** | What ihasmail does not do, and why |
### Companion tools
Two tools for getting a Stalwart server ready for ihasmail, one for each place
you might be starting from:
| | Starting from | What it does |
| --- | --- | --- |
| 🚀 **[ihasmail-oneshot](https://github.com/Coffey-Labs/ihasmail-oneshot)** | **Nothing** — a fresh Linux host with Docker | One command deploys a new Stalwart and a new ihasmail on a single host, already linked: certificates for both, the first mailboxes, and the DNS records to publish. Or `--local` for a loopback-only pair to try it |
| ⬆️ **[stalwart-migrator](https://github.com/Coffey-Labs/stalwart-migrator)** | **An existing Stalwart 0.15.5** server | Upgrades it in place to the 0.16 series ihasmail requires, checkpointing every phase so an interrupted run resumes, and validating the server afterwards. Take a snapshot first: it does not undo a migration |
> **Releases are weekly, so `latest` normally lags `main`.** Automation builds > **Releases are weekly, so `latest` normally lags `main`.** Automation builds
> and publishes the GHCR image every **Monday at 09:00 UTC**, in a week that had > and publishes the GHCR image every **Monday at 09:00 UTC**, in a week that had
> changes. Between one Monday and the next, `main` is ahead of the newest image > changes. Between one Monday and the next, `main` is ahead of the newest image
@@ -114,6 +124,10 @@ reproduces those four.
## Quick start (Docker) ## Quick start (Docker)
No Stalwart yet? [ihasmail-oneshot](https://github.com/Coffey-Labs/ihasmail-oneshot)
sets up both on one host in a single command. The steps below are for pointing
ihasmail at a Stalwart you already run.
```bash ```bash
cp .env.example .env cp .env.example .env
# edit: STALWART_URL=https://mail.example.com and APP_SECRET=$(openssl rand -base64 48) # edit: STALWART_URL=https://mail.example.com and APP_SECRET=$(openssl rand -base64 48)