Welcome to the daycry/maintenancemode docs. The project root README.md
gives you the 30-second pitch and a quick start; this folder is the long-form
reference.
- First time? → installation.md → examples/basic-maintenance.md
- Configuring? → configuration.md
- Need a CLI command reference? → commands.md
- Bypass logic confusing you? → bypass.md
- Building a SaaS / API / scheduled window? → see
examples/
| Guide | What's inside |
|---|---|
| installation.md | composer require, publishing the config, first run |
| configuration.md | Every field of Config\Maintenance, with defaults and examples |
| commands.md | mm:down, mm:up, mm:status, mm:migrate, mm:publish, all flags |
| bypass.md | IP / CIDR / secret URL / cookie — order, semantics, security |
| filters-and-events.md | Wiring the filter, listening to maintenance.* events |
| storage-drivers.md | file vs cache, when to pick which, migrating between them |
| architecture.md | Internal flow diagram (Filter → Service → Storage) |
| security.md | Threat model and hardening notes |
| troubleshooting.md | Common pitfalls + diagnosis |
| faq.md | Quick answers to recurring questions |
| upgrade.md | Migration notes between major versions |
| roadmap.md | What's next and how to influence it |
Real, runnable end-to-end recipes:
- basic-maintenance.md — the happy path
- scheduled-window.md —
--start/--endtimes - api-json-response.md — JSON 503 for APIs
- webhook-notifications.md — Slack / PagerDuty on maintenance events
- multi-tenant.md — per-tenant maintenance (planned)
- cdn-cloudflare.md — getting the real client IP behind a CDN (planned)
Items marked "planned" still depend on roadmap features (multi-tenant isolation, first-class trusted-proxy presets). They live here as stubs so the documentation structure is in place when those features land. Each stub also includes a workaround you can use today.