PHPackages                             sylvainjule/backups - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File & Storage](/categories/file-storage)
4. /
5. sylvainjule/backups

ActiveKirby-plugin[File & Storage](/categories/file-storage)

sylvainjule/backups
===================

Manage backups from the Kirby panel

1.1.0(11mo ago)424.4k↓55.8%4[1 PRs](https://github.com/sylvainjule/kirby-backups/pulls)MITPHP

Since Apr 13Pushed 11mo ago2 watchersCompare

[ Source](https://github.com/sylvainjule/kirby-backups)[ Packagist](https://packagist.org/packages/sylvainjule/backups)[ RSS](/packages/sylvainjule-backups/feed)WikiDiscussions master Synced yesterday

READMEChangelog (7)Dependencies (1)Versions (8)Used By (0)

Kirby Backups
=============

[](#kirby-backups)

This plugin allows you to create, download and manage backups from a dedicated View. Works together with [kirby-janitor](https://github.com/bnomei/kirby3-janitor).

[![screenshot-k5](https://private-user-images.githubusercontent.com/14079751/475254061-33bcced6-ca33-4058-8c42-cd89481dc2ad.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODI3MTE1NTcsIm5iZiI6MTc4MjcxMTI1NywicGF0aCI6Ii8xNDA3OTc1MS80NzUyNTQwNjEtMzNiY2NlZDYtY2EzMy00MDU4LThjNDItY2Q4OTQ4MWRjMmFkLmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA2MjklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNjI5VDA1MzQxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWJjNTFhYjJlOTg5ODc4NjAzZGVmMzJiNTI3Y2ZiOGI0NWE0ZTlmOTM5YTNkMGM2Y2UzMTJiNzQ5OTM3YTA0MjAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRmpwZWcifQ.2RusrjxLV_HMVchmWxcHmRk9kzHdHbioCSIL3bHdDto)](https://private-user-images.githubusercontent.com/14079751/475254061-33bcced6-ca33-4058-8c42-cd89481dc2ad.jpg?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODI3MTE1NTcsIm5iZiI6MTc4MjcxMTI1NywicGF0aCI6Ii8xNDA3OTc1MS80NzUyNTQwNjEtMzNiY2NlZDYtY2EzMy00MDU4LThjNDItY2Q4OTQ4MWRjMmFkLmpwZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNjA2MjklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjYwNjI5VDA1MzQxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWJjNTFhYjJlOTg5ODc4NjAzZGVmMzJiNTI3Y2ZiOGI0NWE0ZTlmOTM5YTNkMGM2Y2UzMTJiNzQ5OTM3YTA0MjAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JnJlc3BvbnNlLWNvbnRlbnQtdHlwZT1pbWFnZSUyRmpwZWcifQ.2RusrjxLV_HMVchmWxcHmRk9kzHdHbioCSIL3bHdDto)

Overview
--------

[](#overview)

> This plugin is completely free and published under the MIT license. However, if you are using it in a commercial project and want to help me keep up with maintenance, you can consider [making a donation of your choice](https://www.paypal.me/sylvainjl).

- [1. Installation](#1-installation)
- [2. Usage](#2-usage)
- [3. License](#3-license)
- [4. Credits](#4-credits)

1. Installation
---------------

[](#1-installation)

> Kirby 3: up to 1.0.3. Kirby 4: up to 1.0.5. Kirby 5: 1.1.0+.
> You also **must install [kirby-janitor](https://github.com/bnomei/kirby3-janitor)** (and the CLI per janitor's instructions) for this plugin to work.
> For older releases, install the kirby-janitor release from the same timeframe.

Download and copy this repository to `/site/plugins/backups`

Alternatively, you can install it with composer: `composer require sylvainjule/backups`

2. Usage
--------

[](#2-usage)

The plugin will work out of the box, no need for additionnal setup.

You can, however, change the prefix of the backups' filename (default is `backup-{TIMESTAMP}.zip`)

```
// site/config.php
return [
    'sylvainjule.backups.prefix' => 'backup-',
];
```

Any backup, created either with this plugin or with any of the janitor's options (CLI, CRON job, etc), will now show up in the Backups view.

Janitor stores the backups in a `site/backups` folder. This folder isn't public and we should keep it that way. Therefore, anytime a user triggers a *Download* button, the plugin will create a copy of the given backup in a `backups-temp` folder and expose an url from there.

When the user leaves the view, copies will be deleted.

This default public `assets/backup-temp` folder can be changed to any name you'd like:

```
// site/config.php
return [
    // backups will be copied in assets/my-secretly-public-backups
    'sylvainjule.backups.publicFolder' => 'my-secretly-public-backups',
];
```

If you want more control over where backups are created / copied, you can set both paths with their dedicated option (if you change the public path, make sure to fill both the `publicPath` and `publicUrl` options):

```
// site/config.php
return [
    // if filled, backups will be created here
    'sylvainjule.backups.path' => '{{ kirby.root("site") }}/my-custom-folder',
    // if filled, backups will be copied here for downloading (in this case, it will take precedence over the publicFolder option)
    'sylvainjule.backups.publicPath' => '{{ kirby.root("assets") }}/my-custom-folder',
    'sylvainjule.backups.publicUrl'  => '{{ kirby.url("assets") }}/my-custom-folder',
];
```

You can enforce a maximum number of backups by setting the `maximum` option to any integer (default is `false`). If this number is reached the oldest backup will be deleted automatically whenever a new backup is created. If included in a client website, you should include a note specifying an expected frequency of backup creation / deletion (or set up a CRON job).

```
// site/config.php
return [
    'sylvainjule.backups.maximum' => 5,
];
```

If you want to create backups from a CRON job and still benefit from this `maximum` option, the plugin exposes a tweaked janitor webhook:

```
https://your.domain/backups-webhook/{janitor.secret}/create-backup

```

If you have set the `maximum` option to a high amount, you can choose the pagination limit of the table with the `limit` option (default is `20`).

```
// site/config.php
return [
    'sylvainjule.backups.limit' => 20,
];
```

There's also a way to disable the "Backups" menu-item for specific user roles:

```
# site/blueprints/users/{role}.yml
permissions:
  access:
    backups: false
```

3. License
----------

[](#3-license)

MIT

4. Credits
----------

[](#4-credits)

- The plugin relies on the Janitor plugin by [@bnomei](https://github.com/bnomei), who tweaked it a bit in order to make the development of Backups easier. 🙏

###  Health Score

43

—

FairBetter than 89% of packages

Maintenance52

Moderate activity, may be stable

Popularity34

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 94.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~375 days

Recently: every ~338 days

Total

6

Last Release

330d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/14079751?v=4)[Sylvain Julé](/maintainers/sylvainjule)[@sylvainjule](https://github.com/sylvainjule)

---

Top Contributors

[![sylvainjule](https://avatars.githubusercontent.com/u/14079751?v=4)](https://github.com/sylvainjule "sylvainjule (32 commits)")[![bastianallgeier](https://avatars.githubusercontent.com/u/24532?v=4)](https://github.com/bastianallgeier "bastianallgeier (1 commits)")[![REHvision](https://avatars.githubusercontent.com/u/2584674?v=4)](https://github.com/REHvision "REHvision (1 commits)")

---

Tags

backupsjanitorkirbykirby-pluginstorage

### Embed Badge

![Health badge](/badges/sylvainjule-backups/health.svg)

```
[![Health](https://phpackages.com/badges/sylvainjule-backups/health.svg)](https://phpackages.com/packages/sylvainjule-backups)
```

###  Alternatives

[getkirby/cms

The Kirby core

1.5k584.8k472](/packages/getkirby-cms)[medienbaecker/kirby-modules

Easily add modules to your pages

895.5k1](/packages/medienbaecker-kirby-modules)[johannschopplich/kirby-content-translator

DeepL & AI-powered content translation for Kirby CMS

2010.8k](/packages/johannschopplich-kirby-content-translator)[medienbaecker/kirby-alter

242.1k](/packages/medienbaecker-kirby-alter)[fabianmichael/kirby-template-attributes

Better HTML attribute handling for your snippets and templates.

238.4k1](/packages/fabianmichael-kirby-template-attributes)[grommasdietz/kirby-blueprint-areas

Add custom Panel areas via blueprints on Kirby CMS

211.2k](/packages/grommasdietz-kirby-blueprint-areas)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)