Documentation
Every screen. Every box.
User guide first: a picture, then what each box does. Operator & API reference below.
User guide
For customers and mailbox owners. 23 short pages.
Your hosting account
The tenant console: websites, apps, mail, files, databases, backups.
Signing inYour hosting account. Email, password, code. The bar at the top.
OverviewYour account at a glance. Usage, bandwidth, what needs attention, recent changes.
WebsitesYour sites and domains. Add one. Check it works. PHP, webmail, certificate.
Site settingsConfigure on a site. Seven tabs, one Save. Then client certificates.
AppsRun a container or a program. Deploy a recipe. Logs, ports, nodes, image, shell.
MailMail domains, the send queue, external forwarding, held mail, import and sync.
Mail domainOne domain: mailboxes, forwarders and catch-all, spam rules, branding, deliverability, mail security.
One mailboxManage a mailbox for its owner: size, password, compromised, out of office, rules, devices.
Outbound routingHow a domain sends. Sending limits. Relays and routes. Publish mail DNS.
DNSA zone's records, its delegation, and DNSSEC signing.
FilesBrowse, upload, rename, archive. Disk use. Connecting with SFTP.
Databases & tasksMariaDB and PostgreSQL databases, their users, and scheduled tasks.
BackupsDestinations, schedules, snapshots. Verify and restore.
NotificationsWhat you are told, and how: in the panel, by email. The feed.
PlanWhat your plan includes, and what actually enforces it.
SecurityPassword, two-factor, where you are signed in, API tokens.
Your mailbox
The mailbox console: one person, one address.
Mailbox: sign in and overviewYour own mailbox. Sign in, the bar, activity, storage, limits.
Mailbox: rules and away messageFile, delete or keep mail as it arrives. Out-of-office reply.
Mailbox: spam and heldWhat the filter did. How strict. Senders you always accept or reject. Held mail.
Mailbox: import and syncCopy mail in from Gmail, Outlook or any IMAP account. Once, one-way or two-way.
Mailbox: notifications and the appThe feed. How you are told. Install the mailbox as an app. New-mail notifications per device.
Mailbox: securityTwo passwords, two-factor, connected apps, app passwords, access tokens, API keys.
Mailbox: settings and webmailDefault webmail, new-mail sound, opening Roundcube or SOGo.
Operator & API reference
For whoever runs the cluster or connects to it: install, nodes, engines, routes, CLI. 11 chapters.
- Installing ozpanelRequirements, DNS, both installers, bootstrap steps, resume, floating IP, config, updates.Overview · Requirements · DNS records · install-node.sh · ozpanel install · CLI used at install · Bootstrap steps · Following and resuming …
- The clusterIdentity, roles, joining, succession, failover, handover, eviction, addresses, convergence, recovery.Overview · Identity and transport · Adding a node · Roles · Succession · Failover · Handover and failback · Removing a node …
- Web hosting and CaddySite modes, every per-site option, global Caddy options, certificates, PHP, logs, checks.How it works · Site modes · Per-site options · Client certificates (mTLS) · Global Caddy options · Certificates · Domains and pages · Proxy target rules …
- Apps and containersProcess and container apps, every field, placement, interlock, ports, storage, images, limits.Overview · Fields · Placement · Interlock and failover · Public ports · Container storage · Images · Sandbox and limits …
- MailStack, routing and relays, forwarding, import and sync, spam, deliverability, mailboxes, client servicing.Stack · Mail domains · Routing · Sending limits · Import and sync · Spam and malware · Deliverability · Mailboxes and client servicing …
- Webmail, webapp and pushWebmail portal, SSO into Roundcube and SOGo, the mailbox app, branding, Web Push, notifications.The portal · Single sign-on · The mailbox app · Branding · Web Push · Notifications and alerts
- DNSPowerDNS on every node, records, automatic and liveness answers, nameservers, DNSSEC, providers, Namecheap.The DNS server · Zones and records · Automatic records · Liveness answers · Nameservers · DNSSEC · Verification · Providers and Namecheap …
- DatabasesMariaDB Galera, PostgreSQL with repmgr and PgBouncer, Redis Sentinel, tenant databases, settings.Three engines · MariaDB and Galera · PostgreSQL, repmgr, PgBouncer · Redis and Sentinel · Tenant databases · Engine settings · CLI
- Tenants, plans and filesTenants, plans and every limit, resource control, files, SFTP, cron, terminal, shared storage, backups.Tenants · Plans and limits · Consoles and logins · Files, SFTP, cron, terminal · Shared storage · Backups
- SecurityGenerated firewall, tenant network policy, CrowdSec, SSH, secrets, logins, sessions, audit, signed releases.Layers · Firewall · Tenant network policy · CrowdSec · SSH · Secrets · Logins and sessions · Audit log …
- API and automationOpenAPI, sessions and scoped tokens, access tokens, conventions, jobs and events, console vs CLI, every CLI command.Overview · Authentication and tokens · Conventions · Jobs and events · Routes by area · Route tables · Console or CLI · The ozpanel CLI