PHPackages                             spark-green/silverstripe-backup - 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. spark-green/silverstripe-backup

ActiveSilverstripe-module

spark-green/silverstripe-backup
===============================

Backs up assets and database into your assets directory

14291PHP

Since Feb 25Pushed 10y ago1 watchersCompare

[ Source](https://github.com/spark-green/silverstripe-backup)[ Packagist](https://packagist.org/packages/spark-green/silverstripe-backup)[ RSS](/packages/spark-green-silverstripe-backup/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Spark Green Backups Module
==========================

[](#spark-green-backups-module)

Authors
-------

[](#authors)

```
* Julian Smith

```

Overview
--------

[](#overview)

This module allows Database and Assets backups to be conducted via the CMS, URLs and commandline. It allows facilitates the transfer of backups to a target server.

Requirements
------------

[](#requirements)

```
* SilverStripe 3.*

```

Installation
------------

[](#installation)

composer require spark-green/silverstripe-backup dev-master

Usage
-----

[](#usage)

### Setup

[](#setup)

SSH keys must be set up to allow apache user to ssh to target server without password

### CMS

[](#cms)

Backup will appear as a tab in the Settings of the CMS. Here you can set whether you would like it backup the database, assets, or both. You can also choose whether you would like to transer the files via SSH as well as defining the SSH settings for transfer. Remember to save your settings before pressing the 'Back up now' button.

You must also enter up to two IP address from which you would like the task to be called.

### via Commandline

[](#via-commandline)

To call the task via commandline, first, change the directory to your webroot using the 'cd' command:

```
'cd /path/to/your/site'

```

Follow this command with:

```
'sake /BackupTask'.

```

The task will use the settings set in the CMS by default but you can override these by setting any of three boolean parameters in the command.

The parameters are 'db', 'assets', and 'ssh'. 'db' and 'assets' defines whether you would like to back up the database and assets. 'ssh' defines whether you would like to transfer the backups to a target server. In this case the SSH settings from \_config.php would override the SSH settings from the CMS.

For example, if you wanted to back up just the database and transfer it to your target server the command would be:

```
'sake /BackupTask db=true ssh=true'

```

If you wanted to back up the database and assets but have no transfer take place the command would be:

```
'sake /BackupTask db=true assets=true'

```

If you pass no parameters the CMS Settings will be used

### via URL

[](#via-url)

Calling the task through the URL is similar to calling through the commandline. The URL to call the task will be:

```
/your/site/webroot/BackupTask

```

The URL uses the same parameters as the commandline but in a query string:

```
/your/site/webroot/BackupTask?db=true&assets=true&ssh=true

```

Setting SSH to true when calling the task through the URL will use the default SSH Settings or those set in the \_config.php file.

If you pass no parameters the CMS Settings will be used.

---

I think that about covers it! If you have any questions contact one of the authors. Probably Dylan.

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 85.7% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/31fbc3b00747be4b6bc54f1a97f1817ae3605681ef8b51eb33e2d7f105e1fe56?d=identicon)[sparkgreen](/maintainers/sparkgreen)

---

Top Contributors

[![spark-green](https://avatars.githubusercontent.com/u/2790964?v=4)](https://github.com/spark-green "spark-green (6 commits)")[![DarrenInwood](https://avatars.githubusercontent.com/u/2244071?v=4)](https://github.com/DarrenInwood "DarrenInwood (1 commits)")

### Embed Badge

![Health badge](/badges/spark-green-silverstripe-backup/health.svg)

```
[![Health](https://phpackages.com/badges/spark-green-silverstripe-backup/health.svg)](https://phpackages.com/packages/spark-green-silverstripe-backup)
```

PHPackages © 2026

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