Skip to content

Commit 08fb937

Browse files
Upgrade to version 6
1 parent 05ee20b commit 08fb937

File tree

1 file changed

+31
-17
lines changed

1 file changed

+31
-17
lines changed

README.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,22 @@
22

33
**PHP Backup Utility**
44

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
66
and assists you monitor your backup creation.
77

88
Get an in depth look into all the features and a short 'getting started' tutorial at the [PHPBU Website](https://phpbu.de).
99

1010
[![Latest Stable Version](https://poser.pugx.org/phpbu/phpbu/v/stable.svg)](https://packagist.org/packages/phpbu/phpbu)
11-
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.0-8892BF.svg)](https://php.net/)
11+
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.2-8892BF.svg)](https://php.net/)
1212
[![Downloads](https://img.shields.io/packagist/dt/phpbu/phpbu.svg?v1)](https://packagist.org/packages/phpbu/phpbu)
1313
[![License](https://poser.pugx.org/phpbu/phpbu/license.svg)](https://packagist.org/packages/phpbu/phpbu)
1414
[![Build Status](https://travis-ci.org/sebastianfeldmann/phpbu.svg?branch=master)](https://travis-ci.org/sebastianfeldmann/phpbu)
1515
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sebastianfeldmann/phpbu/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sebastianfeldmann/phpbu/?branch=master)
1616
[![Code Coverage](https://scrutinizer-ci.com/g/sebastianfeldmann/phpbu/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/sebastianfeldmann/phpbu/?branch=master)
1717
[![PHP Website](https://img.shields.io/website-up-down-green-red/https/phpbu.de.svg)](https://phpbu.de)
1818

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)
2021

2122
## Features
2223

@@ -57,10 +58,16 @@ If you are not using php 7.0 or greater already you can still use phpbu version
5758
+ Store only x MB of backups
5859
+ Keep only last x backups
5960
+ Keep less backups for more distant past
61+
* Writing backup reports
62+
+ Text file
63+
+ Json file
64+
+ Mail
65+
+ Telegram
66+
+ Webhook
6067

6168
## Requirements
6269

63-
* PHP >= 7.0
70+
* PHP >= 7.2
6471
+ ext/curl
6572
+ ext/dom
6673
+ ext/json
@@ -90,50 +97,57 @@ Installing *PHPBU* via Composer is also supported.
9097

9198
```json
9299
"require": {
93-
"phpbu/phpbu": "~5.0"
100+
"phpbu/phpbu": "^6.0"
94101
}
95102
```
96103

97104
## Usage
98105
```
99106
phpbu [option]
100107
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.
110119
```
111120

112121
### Usage Examples
113122

114123
$ phpbu
115124

116125
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.
118128

119129
$ phpbu --configuration=backup/config.xml
120130

121131
Use the *--limit* option to execute only a subset of your configured backups.
122132

123133
$ phpbu --limit=myAppDB
124134

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.
126136

127137
$ phpbu --simulate
138+
139+
To show a guide how to restore your backup use the *--restore* option.
128140

141+
$ phpbu --restore
142+
129143
## Configuration Example
130144

131145
Simple configuration example:
132146

133147
```xml
134148
<?xml version="1.0" encoding="UTF-8"?>
135149
<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"
137151
verbose="true">
138152
<backups>
139153
<backup name="myAppDB">

0 commit comments

Comments
 (0)