coffey-labs/ihasmail-oneshot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Put the documentation links first, with the guide marked as the place to start

Browse Source
This commit is contained in:
jcoffey-dev
2026-09-15 12:25:35 -07:00
parent 07ed6ea582
commit bbd84da276
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -11
View File
@@ -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) [![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) [![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 **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 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 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 ## What you get
- A mail server for `example.com`, with webmail at `https://webmail.example.com` - 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 and asks before changing anything. Then publish `dns-records.zone`, and mail
flows. 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 ## Versions
Releases are tagged by date (`v2026.9.15`). Each pins the Stalwart and Caddy Releases are tagged by date (`v2026.9.15`). Each pins the Stalwart and Caddy