coffey-labs/stalwart-migrator
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Merge pull request #19 from Coffey-Labs/docs/guide-link-first

Browse Source 
README: documentation links first
This commit is contained in:
jcoffey
2026-09-15 12:31:22 -07:00
committed by GitHub
parent 86ccbd7547 1b4258113e
commit f3a4d021ab
1 changed files with 15 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -16
View File
@@ -1,5 +1,8 @@
# stalwart-migrator # stalwart-migrator
[![License: GPL-3.0-or-later](https://img.shields.io/badge/license-GPL--3.0--or--later-blue)](LICENSE)
[![Docs: docs.ihasmail.org](https://img.shields.io/badge/docs-docs.ihasmail.org-0ea5e9)](https://docs.ihasmail.org/install/stalwart-migrator/)
In-place upgrade tool for Stalwart Mail Server, 0.15.5 → 0.16: no data loss, a In-place upgrade tool for Stalwart Mail Server, 0.15.5 → 0.16: no data loss, a
checkpoint at every step so an interrupted run resumes instead of restarting, checkpoint at every step so an interrupted run resumes instead of restarting,
and automated validation that the server still works afterwards. Go, standard and automated validation that the server still works afterwards. Go, standard
@@ -16,9 +19,18 @@ it needs.
> checked. `run` will not start until you confirm you have one. See > checked. `run` will not start until you confirm you have one. See
> [Recovery](docs/recovery.md). > [Recovery](docs/recovery.md).
**Full guide:** [docs.ihasmail.org/install/stalwart-migrator](https://docs.ihasmail.org/install/stalwart-migrator/) ## Documentation
walks through the whole upgrade — what to fix first, rehearsing, running it,
and what to check afterwards. | | |
| --- | --- |
| 📘 **[Upgrade guide](https://docs.ihasmail.org/install/stalwart-migrator/)** | **Start here.** The whole upgrade, step by step, on docs.ihasmail.org: what to fix first, rehearsing, running it, and what to check afterwards |
| 🧪 **[Rehearsing](docs/rehearsal.md)** | Running preflight safely, what `rehearse` reports, rehearsing on a clone |
| 🐳 **[Docker](docs/docker.md)** | Container deployments: flags, what cutover carries and refuses, where the config goes |
| ⚠️ **[Known Stalwart problems](docs/known-stalwart-problems.md)** | Tenants, the admin account, dropped ACME, certificates on mail ports, the extra recovery boot |
| 🛟 **[Recovery](docs/recovery.md)** | Why recovery is your snapshot, what the tool keeps, never booting recovery mode again |
| 📊 **[Status](docs/status.md)** | Command and package state, validation, field reports |
| ⚙️ **[Architecture](ARCHITECTURE.md)** | The design: phases, checkpoints, and the reasoning behind them |
| 🔧 **[Contributing](CONTRIBUTING.md)** | Building, testing, and where the design is written down |
## Requirements ## Requirements
@@ -88,19 +100,6 @@ open: some store migrations need one more recovery-mode boot, which is a manual
step, and the Docker path has never completed a migration against a real step, and the Docker path has never completed a migration against a real
Stalwart image. Details and field reports: [Status](docs/status.md). Stalwart image. Details and field reports: [Status](docs/status.md).
## Documentation
| | |
| --- | --- |
| [Upgrade guide](https://docs.ihasmail.org/install/stalwart-migrator/) | The whole upgrade, step by step, on docs.ihasmail.org |
| [docs/rehearsal.md](docs/rehearsal.md) | Running preflight safely, what `rehearse` reports, rehearsing on a clone |
| [docs/docker.md](docs/docker.md) | Container deployments: flags, what cutover carries and refuses, where the config goes |
| [docs/known-stalwart-problems.md](docs/known-stalwart-problems.md) | Tenants, the admin account, dropped ACME, certificates on mail ports, the extra recovery boot |
| [docs/recovery.md](docs/recovery.md) | Why recovery is your snapshot, what the tool keeps, never booting recovery mode again |
| [docs/status.md](docs/status.md) | Command and package state, validation, field reports |
| [ARCHITECTURE.md](ARCHITECTURE.md) | The design: phases, checkpoints, and the reasoning behind them |
| [CONTRIBUTING.md](CONTRIBUTING.md) | Building, testing, and where the design is written down |
## License ## License
Copyright (C) 2026 Coffey Labs. GPL-3.0-or-later: free software, with no Copyright (C) 2026 Coffey Labs. GPL-3.0-or-later: free software, with no