1- # DatabaseBackup
1+ # cakephp-database-backup
22
33[ ![ Software License] ( https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square )] ( LICENSE.txt )
44[ ![ Build Status] ( https://api.travis-ci.org/mirko-pagliai/cakephp-database-backup.svg?branch=master )] ( https://travis-ci.org/mirko-pagliai/cakephp-database-backup )
55[ ![ Build status] ( https://ci.appveyor.com/api/projects/status/imerokwpvy0r51fj/branch/master?svg=true )] ( https://ci.appveyor.com/project/mirko-pagliai/cakephp-database-backup/branch/master )
66[ ![ codecov] ( https://codecov.io/gh/mirko-pagliai/cakephp-database-backup/branch/master/graph/badge.svg )] ( https://codecov.io/gh/mirko-pagliai/cakephp-database-backup )
77[ ![ CodeFactor] ( https://www.codefactor.io/repository/github/mirko-pagliai/cakephp-database-backup/badge/develop )] ( https://www.codefactor.io/repository/github/mirko-pagliai/cakephp-database-backup/overview/develop )
88
9- * DatabaseBackup* is a CakePHP plugin to export, import and manage database backups.
9+ * DatabaseBackup* is a CakePHP plugin to export, import and manage database backups.
1010Currently, the plugin supports * MySql* , * Postgres* and * Sqlite* databases.
1111
12- Did you like this plugin? Its development requires a lot of time for me.
12+ Did you like this plugin? Its development requires a lot of time for me.
1313Please consider the possibility of making [ a donation] ( //paypal.me/mirkopagliai ) :
1414even a coffee is enough! Thank you.
1515
@@ -22,26 +22,28 @@ You can install the plugin via composer:
2222$ composer require --prefer-dist mirko-pagliai/cakephp-database-backup
2323```
2424
25- ** NOTE: the latest version available requires at least CakePHP 3.7** .
25+ ``` bash
26+ $ composer require --prefer-dist mirko-pagliai/cakephp-assets:dev-cakephp3
27+ ```
2628
27- Instead, the [ cakephp3.2 ] ( //github.com/mirko-pagliai/cakephp-database-backup/tree/cakephp3.2 )
28- branch is compatible with all previous versions of CakePHP from version 3.2.
29+ Instead, the [ cakephp3] ( //github.com/mirko-pagliai/cakephp-database-backup/tree/cakephp3 )
30+ branch is compatible with all previous versions of CakePHP from version 3.5.1.
2931In this case, you can install the package as well:
3032
3133``` bash
32- $ composer require --prefer-dist mirko-pagliai/cakephp-database-backup:dev-cakephp3.2
34+ $ composer require --prefer-dist mirko-pagliai/cakephp-database-backup:dev-cakephp3
3335```
3436
35- After installation, you have to edit ` APP/config/bootstrap.php ` to load the plugin:
37+ Then you have to load the plugin. For more information on how to load the plugin,
38+ please refer to the [ Cookbook] ( //book.cakephp.org/4.0/en/plugins.html#loading-a-plugin ) .
3639
37- ``` php
38- Plugin::load('DatabaseBackup', ['bootstrap' => true]);
40+ Simply, you can execute the shell command to enable the plugin:
41+ ``` bash
42+ bin/cake plugin load DatabaseBackup
3943```
44+ This would update your application's bootstrap method.
4045
41- For more information on how to load the plugin, please refer to the
42- [ Cookbook] ( http://book.cakephp.org/3.0/en/plugins.html#loading-a-plugin ) .
43-
44- By default the plugin uses the ` APP/backups ` directory to save the backups
46+ By default the plugin uses the ` APP/backups ` directory to save the backups
4547files. So you have to create the directory and make it writable:
4648
4749``` bash
@@ -56,7 +58,7 @@ If you want to use a different directory, read below.
5658* ` pg_dump ` and ` pg_restore ` for * Postgres* databases;
5759* ` sqlite3 ` for * Sqlite* databases.
5860
59- ** Optionally** , if you want to handle compressed backups, ` bzip2 ` and ` gzip ` are
61+ ** Optionally** , if you want to handle compressed backups, ` bzip2 ` and ` gzip ` are
6062also required.
6163
6264The installation of these binaries may vary depending on your operating system.
@@ -71,7 +73,7 @@ The plugin uses some configuration parameters. See our wiki:
7173
7274If you want to send backup files by email, remember to set up your application
7375correctly so that it can send emails. For more information on how to configure
74- your application, see the [ Cookbook] ( https://book.cakephp.org/3 .0/en/core-libraries/email.html#configuring-transports ) .
76+ your application, see the [ Cookbook] ( https://book.cakephp.org/4 .0/en/core-libraries/email.html#configuring-transports ) .
7577
7678## How to use
7779See our wiki:
@@ -84,6 +86,6 @@ See our wiki:
8486And refer to our [ API] ( //mirko-pagliai.github.io/cakephp-database-backup ) .
8587
8688## Versioning
87- For transparency and insight into our release cycle and to maintain backward
88- compatibility, * DatabaseBackup* will be maintained under the
89+ For transparency and insight into our release cycle and to maintain backward
90+ compatibility, * DatabaseBackup* will be maintained under the
8991[ Semantic Versioning guidelines] ( http://semver.org ) .
0 commit comments