Back up without thinking about it
By default ToutWAF backs itself up every 24 hours and keeps the 7 most recent archives; you can choose a time, an interval or a cron expression.
备份
Back up ToutWAF (and the linked ToutPanel) from one page: a daily schedule, a restore test after every backup, encrypted archives, off-site targets, a guided restore with a preview and an automatic rollback if it fails.
Where to find it in the console : Console: Infrastructure > Backups; command line: toutwafctl backup and toutwafctl restore.
What it is for
A backup that restores
Right after it is made, each local archive is restored to a blank: database integrity, same inventory, no private key in clear. An archive that does not restore is not a success and raises an alert.
Encrypted before it leaves
Every archive is encrypted (AES-256-GCM) before it is written or sent anywhere: with a passphrase, or with the installation's master key.
Restore without surprises
The restore guide compares the archive to the live database and says what would change before you confirm. If the console does not come back healthy, the previous data is put back.
What is backed up and where
The state of the control plane: the data plane holds nothing unique, you reinstall it and enrol it again.
The control plane
Database (policies and versions, sites, users, audit log, lists, certificates, integrations, events on request) and the master key. Secrets are sealed before they reach the database.
Off-site targets
A directory, S3, SFTP (server fingerprint pinned), WebDAV or a command, each with its own schedule, retention and bandwidth limit. Under licence: the local backup stays free.
ToutPanel
When a ToutPanel is linked, the page shows the state of its backup plans and can create one from the console. Its archives stay in ToutPanel.
Command line
toutwafctl backup create, list, download, targets, run, verify; toutwafctl restore for an offline restore, with the service stopped.
Stale backup alert
A default rule alerts when the last good backup of a destination is older than 36 hours.
Standby console
A second console can follow the first and take over by hand. Under licence.
The important point: the master key
It unseals integration passwords, SSO secrets, TOTP seeds and ACME credentials.
- A passphrase backup also carries the master key and restores on another server; a master-key backup is useless without that key.
- ToutWAF can generate the passphrase for you, shown once: keep a copy outside the server.
- Test a restore before you need it.
After a disaster
The documentation checklist, in short.
- Install a new host with the same version (or newer), restore ToutPanel first if it is linked, then ToutWAF.
- Nodes keep their token as long as the control plane's data directory was restored; otherwise create new enrolment tokens.
- Traffic is not interrupted by a control-plane outage: nodes serve their last good policy.
What is not done, or not proven
We prefer to say it plainly.
- No real S3, SFTP or WebDAV target has been tried: the tests use the directory target.
- No real ToutPanel and no backup on a real machine (systemd, full disk, system time zones): everything was tested with a fake ToutPanel API. The restore is tested in a fresh directory.
- The settings and accounts of ToutPanel itself cannot be reached with the token ToutWAF holds: save them from ToutPanel.
- Not done yet: a single destination and history for ToutPanel and ToutWAF archives, and backups in the PDF reports.
Use cases
Before an upgrade
You create a named backup, download it, then upgrade with a way back.
A copy off the server
A scheduled SFTP or S3 target, with a restore test after every upload.
Come back after an outage
On a new host, you follow the restore guide and check with the Doctor.
What is included, by edition
The basics are free; the advanced options need a paid offer. An option under licence stays visible in the console, locked, never hidden.
版本免费 包含在所有方案中，包括两个免费方案（Free 和 Free +）Pro 及以上 付费方案：在控制台中可见，无许可证时被锁定。从 Pro 起，另有标注 Agency 或 Enterprise 的除外
尚未在真实环境中试过 在产品测试中运行正常，但尚未用真实的服务、系统或设备试过。您设置该功能时，控制台会在相应位置显示同样的提示。
- 控制台的定时本地备份，每次备份后都做一次恢复测试免费
- 带预览的引导式恢复，自动重启，并可回滚免费
- 备份中没有明文机密：密钥、令牌和密码都用主密钥加密封存免费
- 可在同一页面启动已关联 ToutPanel 的备份计划免费
- 异地目标：S3、SFTP、WebDAV 或自定义命令Pro 及以上
- 备份服务器：备份受监控服务器的文件和数据库（MySQL、MariaDB、PostgreSQL），用只有您持有的恢复密钥加密，并通过恢复测试验证Pro 及以上
- 备用控制台：每小时一份加密且经校验的副本，由您手动引导式接管 尚未在真实环境中试过Agency 及以上
- 即使没有许可证，从备用控制台接管也永远不会被锁定免费
随时都可以把高级选项恢复为默认值。付费许可证结束后会发生什么，见定价页的常见问题：48 小时宽限期、48 小时只读，之后 WAF 防护关闭，直到续订。