Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebastianfeldmann/phpbu
PHP Backup Utility - Creates and encrypts database and file backups, syncs your backups to other servers or cloud services and assists you monitor your backup process
https://github.com/sebastianfeldmann/phpbu
backup encrypted-backups hacktoberfest mongodb-backup mysql-backup php postgresql-backup redis-exporter
Last synced: about 2 months ago
JSON representation
PHP Backup Utility - Creates and encrypts database and file backups, syncs your backups to other servers or cloud services and assists you monitor your backup process
- Host: GitHub
- URL: https://github.com/sebastianfeldmann/phpbu
- Owner: sebastianfeldmann
- License: other
- Created: 2014-10-15T12:23:57.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-03-28T14:55:36.000Z (6 months ago)
- Last Synced: 2024-05-03T00:24:18.585Z (5 months ago)
- Topics: backup, encrypted-backups, hacktoberfest, mongodb-backup, mysql-backup, php, postgresql-backup, redis-exporter
- Language: PHP
- Homepage: https://phpbu.de
- Size: 2.33 MB
- Stars: 1,284
- Watchers: 39
- Forks: 107
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PHPBU
**PHP Backup Utility**
*PHPBU* is a php tool that creates and encrypts backups, syncs your backups to other servers or cloud services
and assists you monitor your backup creation.
Get an in depth look into all the features and a short 'getting started' tutorial at the [PHPBU Website](https://phpbu.de).
[](https://packagist.org/packages/phpbu/phpbu)
[](https://php.net/)
[](https://packagist.org/packages/phpbu/phpbu)
[](https://packagist.org/packages/phpbu/phpbu)
[](https://github.com/sebastianfeldmann/phpbu/actions)
[](https://scrutinizer-ci.com/g/sebastianfeldmann/phpbu/?branch=master)
[](https://scrutinizer-ci.com/g/sebastianfeldmann/phpbu/?branch=master)
[](https://phpbu.de)
If you are not using php 8.0 or greater already you can still use phpbu version [6.0.20](https://phar.phpbu.de/phpbu-6.0.20.phar) \
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) \
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)
## Features
* Creating backups
+ ArangoDB
+ Directories
+ Elasticsearch
+ InfluxDB
+ Ldap
+ MongoDB
+ MySQL
+ Percona XtraBackup
+ PostgreSQL
+ Redis
* Compress backups
+ bzip2
+ gzip
+ xz
+ zip
* Validate backups
+ Check min size
+ Comparing with previous backups
* Encrypting backups
+ mcrypt
+ openssl
* Sync backups to other locations
+ Amazon s3
+ Azure Blob
+ Dropbox
+ FTP
+ Google Drive
+ OpenStack
+ rsync
+ SFTP
+ Softlayer
+ Yandex Disk
* Cleanup your local backup
+ Delete backups older x
+ Store only x MB of backups
+ Keep only last x backups
+ Keep less backups for more distant past
* Writing backup reports
+ Text file
+ Json file
+ Mail
+ Prometheus
+ Telegram
+ Webhook
## Requirements
* PHP >= 7.2
+ ext/curl
+ ext/dom
+ ext/json
+ ext/spl
* POSIX Shell
+ tar
+ bzip2 or gzip
## Installation
You can [download](https://phar.phpbu.de/phpbu.phar) a PHP Archive [(PHAR)](http://php.net/phar) that bundles everything you need to run *PHPBU* in a single file.
wget https://phar.phpbu.de/phpbu.phar
chmod +x phpbu.phar
php phpbu.phar --version
For convenience, you can move the PHAR to a directory that is in your [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29).
mv phpbu.phar /usr/local/bin/phpbu
phpbu --version
Using [PHIVE](https://phar.io) to install *PHPBU*.
phive install phpbu
Installing *PHPBU* via Composer is also supported.
```json
"require": {
"phpbu/phpbu": "^6.0"
}
```
## Usage
```
phpbu [option]
--bootstrap= A "bootstrap" PHP file that is included before the backup.
--configuration= A phpbu xml config file.
--colors Use colors in output.
--debug Display debugging information during backup generation.
--generate-configuration Create a new configuration skeleton.
--limit= Limit backup execution to a subset.
--simulate Perform a trial run with no changes made.
--restore Print a restore guide.
-h, --help Print this usage information.
-v, --verbose Output more verbose information.
-V, --version Output version information and exit.
```
### Usage Examples
$ phpbu
This requires a valid XML *PHPBU* configuration file (phpbu.xml or phpbu.xml.dist) in your current working directory.
Alternatively, you can specify the path to your configuration file. An important thing to note is that all path inside
the configuration should be absolute or relative to the configuration file itself.
$ phpbu --configuration=backup/config.xml
Use the *--limit* option to execute only a subset of your configured backups.
$ phpbu --limit=myAppDB
A dry run without any actual impact is executed with the *--simulate* option.
$ phpbu --simulate
To show a guide how to restore your backup use the *--restore* option.
$ phpbu --restore
## Configuration Example
Simple configuration example in XML:
```xml
```
Simple configuration example in JSON:
```json
{
"verbose":true,
"backups":[
{
"name":"myAppDB",
"source":{
"type":"mysqldump",
"options":{
"databases":"mydbname",
"user":"user.name",
"password":"topsecret"
}
},
"target":{
"dirname":"backup",
"filename":"mysql-%Y%m%d-%H%i.sql",
"compress":"bzip2"
}
}
]
}
```