From bbd84da2764aeb991acd866fe2368d87f46dad3d Mon Sep 17 00:00:00 2001 From: John Coffey Date: Tue, 15 Sep 2026 12:25:35 -0700 Subject: [PATCH] Put the documentation links first, with the guide marked as the place to start --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b29b15c..1265dc7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Latest release](https://img.shields.io/github/v/release/Coffey-Labs/ihasmail-oneshot?sort=date)](https://github.com/Coffey-Labs/ihasmail-oneshot/releases/latest) [![License: AGPL-3.0-or-later](https://img.shields.io/badge/license-AGPL--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/oneshot/) **One command that turns a Linux Docker host into a working mail server with webmail.** It deploys a fresh [Stalwart](https://stalw.art) mail server and a @@ -13,6 +14,17 @@ the DNS records to publish. ihasmail-oneshot deploy --domain example.com --user alice ``` +## Documentation + +| | | +| --- | --- | +| ๐Ÿ“˜ **[Step-by-step guide](https://docs.ihasmail.org/install/oneshot/)** | **Start here.** On docs.ihasmail.org: DNS, ports, deploying, publishing records, signing in, upgrading and backups | +| ๐Ÿ“‹ **[Reference](docs/reference.md)** | Requirements, every command and flag, the deployment directory, upgrading, backing up, removing | +| โš™๏ธ **[How it works](docs/how-it-works.md)** | Why it exists, the deploy sequence, Stalwart setup without its wizard, shared certificates, IP bans behind a proxy | +| ๐Ÿ”’ **[Security model](docs/security-model.md)** | What is exposed, where secrets live, the trust decisions it makes | +| ๐Ÿงฐ **[Troubleshooting](docs/troubleshooting.md)** | Problems by message or symptom, and known limits | +| ๐Ÿงช **[Contributing](CONTRIBUTING.md)** | Building, the unit and end-to-end tests, the code layout, releases | + ## What you get - A mail server for `example.com`, with webmail at `https://webmail.example.com` @@ -69,17 +81,6 @@ It checks the host, shows the plan with the exact ihasmail release it will use, and asks before changing anything. Then publish `dns-records.zone`, and mail flows. -## Documentation - -| | | -| --- | --- | -| ๐Ÿ“˜ **[Step-by-step guide](https://docs.ihasmail.org/install/oneshot/)** | On docs.ihasmail.org: DNS, ports, deploying, publishing records, signing in, upgrading and backups | -| ๐Ÿ“‹ **[Reference](docs/reference.md)** | Requirements, every command and flag, the deployment directory, upgrading, backing up, removing | -| โš™๏ธ **[How it works](docs/how-it-works.md)** | Why it exists, the deploy sequence, Stalwart setup without its wizard, shared certificates, IP bans behind a proxy | -| ๐Ÿ”’ **[Security model](docs/security-model.md)** | What is exposed, where secrets live, the trust decisions it makes | -| ๐Ÿงฐ **[Troubleshooting](docs/troubleshooting.md)** | Problems by message or symptom, and known limits | -| ๐Ÿงช **[Contributing](CONTRIBUTING.md)** | Building, the unit and end-to-end tests, the code layout, releases | - ## Versions Releases are tagged by date (`v2026.9.15`). Each pins the Stalwart and Caddy