tearoom1 / kirby-ftp-backup

1.11.0 2026-10-23 11:38 UTC

Requires

• php: >=8.1
• ext-ftp: *
• ext-zip: *
• getkirby/composer-installer: ^1.2
• phpseclib/phpseclib: ^3.0

Requires (Dev)

• getkirby/cms: ^4.0.0 || ^5.0.0
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^10.0

MIT

• Mathis Koblin

• panel
• backup
• ftp
• kirby

Published on Packagist.org on 2026-10-23 11:38 UTC

README

A Kirby CMS plugin that creates backups of your site content and uploads them to an FTP, FTPS or SFTP server.

Features

• Create ZIP backups of your site content, optionally with extra paths (e.g. accounts) and AES-256 encryption
• Upload to an FTP, FTPS or SFTP server (password or RSA/ECDSA/Ed25519 key), with byte progress and size check
• Simple or tiered retention, locally and on the server; protected backups are never deleted
• Notifications by email or webhook when a run fails, and a Panel warning when the newest backup is too old
• Panel interface (English and German): one list of local and server backups, download, protect, delete, connection test
• Scheduled backups via cron job, Kirby CLI or URL

Installation

Manual Installation

1. Download or clone this repository
2. Place the folder kirby-ftp-backup in your site's /site/plugins directory

Composer Installation

composer require tearoom1/kirby-ftp-backup

Quick Start

1. Add the connection to site/config/config.php:

   'tearoom1.kirby-ftp-backup' => [
       'ftpProtocol' => 'sftp',              // 'ftp', 'ftps' or 'sftp'
       'ftpHost' => 'backup.example.com',
       'ftpUsername' => 'backup',
       'ftpPassword' => 'secret',            // SFTP: or 'ftpPrivateKey' => '/path/to/key'
       'ftpDirectory' => 'backups',
       'backupRetention' => 10,              // keep the 10 newest backups
   ],

2. Open FTP Backup in the Panel, click Test connection, then Create backup.

3. Schedule a daily backup, e.g. at 2 am:

   0 2 * * * php /path/to/site/plugins/kirby-ftp-backup/run.php

Backups are stored in content/.backups, uploaded to the server and rotated according to the retention settings. To get an email when a run fails, add 'notifyEmail' => '[e-mail]'.

Documentation

• Configuration: all options, access control, retention, protected backups, file filtering, extra paths, encryption, notifications and connection tuning
• Automation: cron with run.php, Kirby CLI and URL-based execution
• Operations: restoring a backup, security, troubleshooting, development and tests

Panel Interface

The plugin adds a "FTP Backup" area to your Kirby Panel (in English or German, following the user's Panel language):

• Three tiles: the last backup (how old it is, orange with a hint when it is older than maxBackupAge), the backups on this web server and the backups on the FTP server with their size and when the server was last checked
• One list of all backups, on this web server and on the FTP server, with date, size, where each copy is, whether it is protected and whether the next run will delete it. The date comes from the filename, so copied or restored files keep their creation date
• Per backup: download, protect from deletion, delete the local copy, delete on the server. A backup that is only on the FTP server can be downloaded through the Panel or copied back to this web server
• Create a backup manually with live progress (compression, upload in bytes for FTP and SFTP, cleanup)
• Cancel a running backup (only one backup runs at a time; a second start is rejected)
• Test connection: checks the settings, login, write access and the backup directory without creating a backup

The list of files on the FTP server is cached for serverCacheMinutes (default 15), so opening the Panel does not connect every time. Uploads, cleanup and deleting a server copy (also from cron) mark it as outdated; the refresh button in the Backups section always reads the server. When the server cannot be reached, the last list is shown with the time it was checked.

Requirements

• Kirby 4 or 5
• PHP 8.1+ (Kirby 5 needs 8.2+)
• PHP ZIP extension
• PHP FTP extension

Support

FTP Backup is free and MIT licensed, and it stays that way. If it saves you time, you can help keep it maintained. Paying is voluntary and any amount is welcome.

Agencies and companies that need an invoice can get a Supporter License. You choose the price and whether it covers one project or your whole company. Lemon Squeezy handles the sale as merchant of record, so you get a proper invoice with VAT. The license adds no features and no priority support.

Support this plugin

License

This plugin is licensed under the MIT License

Credits

• Developed by Mathis Koblin
• Assisted by AI Claude Sonnet 4.6

Screenshots

Screenshots use sample content in a 1040 × 598 window at double pixel density (2080 × 1196 pixels). Panel views are cropped to the content area. The main image uses the dark theme.

View	Light	Dark
Overview	Light	Dark