TsubameMail Documentation #
Welcome to the official documentation portal for TsubameMail (https://docs.<your-domain>). Guides are organized by operational role and entry point so every administrator and user has clear, least-privilege instructions.
Role & Portal Matrix #
| Role | Portal URL | Authentication | Primary Scope | Guide |
|---|---|---|---|---|
| Super Admin | https://admin.<your-domain> | Platform Passkey (RP_ID) + Step-Up | Cluster deployment, RDS/TLS, bootstrap, RBAC delegation, backup/recovery, global audit | Super Admin Guide |
| Platform Admin / Operator | https://admin.<your-domain> | Platform Passkey (operator) | Service monitoring, bounded log inspection, alert inbox, maintenance, offline upgrades/rollbacks, AWS SES relay | Platform Admin Guide |
| Tenant Owner | https://console.<your-domain> | Tenant Owner Session (Password/Passkey) | Tenant onboarding, default <slug>.<base> subdomain, custom domain binding & primary switch, appointing Tenant Admins, quotas | Tenant Owner Guide |
| Tenant Admin | https://console.<your-domain> | Tenant Admin Session | DNS records (MX, SPF, DKIM, DMARC, _tsubame-verify TXT), users & mailboxes, App Password policy & revocation | Tenant Admin Guide |
| Tenant End User | https://mail.<your-domain> | Webmail Password / Passkey; App Password for mail apps | Webmail (zh/ja/en), Apple Mail / Thunderbird / Outlook (IMAP/SMTP/POP3), Passkey & App Password security | End User Guide |
Core Security & Architectural Principles #
- Zero Email Content Exposure (ADR-0025): Platform portals (
admin.<your-domain>) and operator logs never render email subjects, bodies, or attachments. User identifiers in operational logs are masked (a***@example.invalid). - Strict Portal & Credential Separation: Platform accounts (
/v1/platform/*, WebAuthn Passkeys) are completely isolated from tenant management sessions (/v1/tenant/*) and end-user mailbox authentication (identitydgRPC). LegacyTSUBAME_OPS_TOKENprincipals never authorize/v1/platform/*endpoints. - Placeholder Convention: All examples in this documentation use RFC 2606 / RFC 6761 reserved domains (
example.invalid,mail.example.invalid) or explicit placeholders (<your-domain>,<slug>.<base>,GENERATE_ME). Replace these with your environment's values during deployment.