Chapter 1. Installing PHPBU

Requirements

PHPBU 6.0 requires PHP 7.2, but using the latest version of PHP is highly recommended.

PHPBU requires the dom and json extensions, which are normally enabled by default.

The different backup sources may need their respective executable binary e.g. mysqldump.

PHP Archive (PHAR)

The easiest way to install PHPBU is to download a PHP Archive (PHAR) that has all required dependencies of PHPBU bundled in a single file.

If the Suhosin extension is enabled, you need to allow execution of PHARs in your php.ini:

suhosin.executor.include.whitelist = phar

To globally install the PHAR:

$ wget http://phar.phpbu.de/phpbu.phar
$ chmod +x phpbu.phar
$ sudo mv phpbu.phar /usr/local/bin/phpbu
$ phpbu --version
phpbu x.y.z by Sebastian Feldmann and Contributors.

You may also use the downloaded PHAR file directly:

$ wget https://phar.phpbu.de/phpbu.phar
$ php phpbu.phar --version
phpbu x.y.z by Sebastian Feldmann and Contributors.

Composer

If you are using Composer to manage your dependencies, simply add phpbu/phpbu to your composer.json file.

{
    "require": {
        "phpbu/phpbu": "^6.0"
    }
}

For a system-wide installation via Composer, just run:

composer global require phpbu/phpbu

Make sure you have ~/.composer/vendor/bin/ in your path.

Framework integrations

The following framework integrations are available:

phpbu-laravel

Integrates phpbu with the laravel artisan command line tool. See the section called “Laravel” for details.

Please open a ticket on GitHub to suggest improvements to this page. Thanks!