|
2 | 2 |
|
3 | 3 | **PHP Backup Utility** |
4 | 4 |
|
5 | | -*PHPBU* is a php framework that creates and encrypts backups, syncs your backups to other servers or cloud services |
| 5 | +*PHPBU* is a php tool that creates and encrypts backups, syncs your backups to other servers or cloud services |
6 | 6 | and assists you monitor your backup creation. |
7 | 7 |
|
8 | 8 | Get an in depth look into all the features and a short 'getting started' tutorial at the [PHPBU Website](https://phpbu.de). |
9 | 9 |
|
10 | 10 | [](https://packagist.org/packages/phpbu/phpbu) |
11 | | -[](https://php.net/) |
| 11 | +[](https://php.net/) |
12 | 12 | [](https://packagist.org/packages/phpbu/phpbu) |
13 | 13 | [](https://packagist.org/packages/phpbu/phpbu) |
14 | 14 | [](https://travis-ci.org/sebastianfeldmann/phpbu) |
15 | 15 | [](https://scrutinizer-ci.com/g/sebastianfeldmann/phpbu/?branch=master) |
16 | 16 | [](https://scrutinizer-ci.com/g/sebastianfeldmann/phpbu/?branch=master) |
17 | 17 | [](https://phpbu.de) |
18 | 18 |
|
19 | | -If you are not using php 7.0 or greater already you can still use phpbu version [4.0.10](https://phar.phpbu.de/phpbu-4.0.10.phar) |
| 19 | +If you are not using php 7.2 or greater already you can still use phpbu version [5.2.10](https://phar.phpbu.de/phpbu-5.2.10.phar) \ |
| 20 | +If you are behind php 7.0 you can still use phpbu version [4.0.10](https://phar.phpbu.de/phpbu-4.0.10.phar) |
20 | 21 |
|
21 | 22 | ## Features |
22 | 23 |
|
@@ -57,10 +58,16 @@ If you are not using php 7.0 or greater already you can still use phpbu version |
57 | 58 | + Store only x MB of backups |
58 | 59 | + Keep only last x backups |
59 | 60 | + Keep less backups for more distant past |
| 61 | +* Writing backup reports |
| 62 | + + Text file |
| 63 | + + Json file |
| 64 | + + Mail |
| 65 | + + Telegram |
| 66 | + + Webhook |
60 | 67 |
|
61 | 68 | ## Requirements |
62 | 69 |
|
63 | | -* PHP >= 7.0 |
| 70 | +* PHP >= 7.2 |
64 | 71 | + ext/curl |
65 | 72 | + ext/dom |
66 | 73 | + ext/json |
@@ -90,50 +97,57 @@ Installing *PHPBU* via Composer is also supported. |
90 | 97 |
|
91 | 98 | ```json |
92 | 99 | "require": { |
93 | | - "phpbu/phpbu": "~5.0" |
| 100 | + "phpbu/phpbu": "^6.0" |
94 | 101 | } |
95 | 102 | ``` |
96 | 103 |
|
97 | 104 | ## Usage |
98 | 105 | ``` |
99 | 106 | phpbu [option] |
100 | 107 |
|
101 | | - --bootstrap=<file> A "bootstrap" PHP file that is included before the backup. |
102 | | - --configuration=<file> A phpbu xml config file. |
103 | | - --colors Use colors in output. |
104 | | - --debug Display debugging information during backup generation. |
105 | | - --limit=<subset> Limit backup execution to a subset. |
106 | | - --simulate Perform a trial run with no changes made. |
107 | | - -h, --help Print this usage information. |
108 | | - -v, --verbose Output more verbose information. |
109 | | - -V, --version Output version information and exit. |
| 108 | + --bootstrap=<file> A "bootstrap" PHP file that is included before the backup. |
| 109 | + --configuration=<file> A phpbu xml config file. |
| 110 | + --colors Use colors in output. |
| 111 | + --debug Display debugging information during backup generation. |
| 112 | + --generate-configuration Create a new configuration skeleton. |
| 113 | + --limit=<subset> Limit backup execution to a subset. |
| 114 | + --simulate Perform a trial run with no changes made. |
| 115 | + --restore Print a restore guide. |
| 116 | + -h, --help Print this usage information. |
| 117 | + -v, --verbose Output more verbose information. |
| 118 | + -V, --version Output version information and exit. |
110 | 119 | ``` |
111 | 120 |
|
112 | 121 | ### Usage Examples |
113 | 122 |
|
114 | 123 | $ phpbu |
115 | 124 |
|
116 | 125 | This requires a valid XML *PHPBU* configuration file (phpbu.xml or phpbu.xml.dist) in your current working directory. |
117 | | -Alternatively, you can specify the path to your configuration file. |
| 126 | +Alternatively, you can specify the path to your configuration file. An important thing to note is that all path inside |
| 127 | +the configuration should be absolute or relative to the configuration file itself. |
118 | 128 |
|
119 | 129 | $ phpbu --configuration=backup/config.xml |
120 | 130 |
|
121 | 131 | Use the *--limit* option to execute only a subset of your configured backups. |
122 | 132 |
|
123 | 133 | $ phpbu --limit=myAppDB |
124 | 134 |
|
125 | | -Use the *--simulate* option to perform a trial run without actually executing the configured backups. |
| 135 | +A dry run without any actual impact is executed with the *--simulate* option. |
126 | 136 |
|
127 | 137 | $ phpbu --simulate |
| 138 | + |
| 139 | +To show a guide how to restore your backup use the *--restore* option. |
128 | 140 |
|
| 141 | + $ phpbu --restore |
| 142 | + |
129 | 143 | ## Configuration Example |
130 | 144 |
|
131 | 145 | Simple configuration example: |
132 | 146 |
|
133 | 147 | ```xml |
134 | 148 | <?xml version="1.0" encoding="UTF-8"?> |
135 | 149 | <phpbu xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
136 | | - xsi:noNamespaceSchemaLocation="http://schema.phpbu.de/5.1/phpbu.xsd" |
| 150 | + xsi:noNamespaceSchemaLocation="http://schema.phpbu.de/6.0/phpbu.xsd" |
137 | 151 | verbose="true"> |
138 | 152 | <backups> |
139 | 153 | <backup name="myAppDB"> |
|
0 commit comments