https://github.com/muckiware/restic
PHP framework for to use restic as backup function
https://github.com/muckiware/restic
backup restic restic-backup
Last synced: 5 months ago
JSON representation
PHP framework for to use restic as backup function
- Host: GitHub
- URL: https://github.com/muckiware/restic
- Owner: muckiware
- License: mit
- Created: 2024-11-25T07:34:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-08T12:22:00.000Z (5 months ago)
- Last Synced: 2026-01-11T19:34:51.101Z (5 months ago)
- Topics: backup, restic, restic-backup
- Language: PHP
- Homepage:
- Size: 41.1 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# muckiware/restic
PHP client for [restic](https://github.com/restic/restic) backup tool. This library provides a simple way to create and manage backups with restic. It uses repositories as storage for backups.
[](https://packagist.org/packages/muckiware/restic)
[](https://packagist.org/packages/muckiware/restic)
[](https://packagist.org/packages/muckiware/restic)
[](https://packagist.org/packages/muckiware/restic)
[](https://github.com/shopware/shopware/blob/trunk/LICENSE)
# Requirements
- PHP 8.1 or higher
- Composer
- Restic as binary or installed on the system, see https://restic.readthedocs.io/en/stable/020_installation.html
- Restic version 0.15.0 or higher
- AWS account with S3 bucket, if you want to use Amazon S3 as external storage for the backup repository
# Installation
```bash
composer require muckiware/restic
```
# Usage
How to use the library. This php client interacts with the restic binary to create, manage and restore backups in and of a repository. The first step is always to create a backup repository as storage for the backup data. After that, you can create backups in this repository and check the backup data. And at least if its necessary, you can restore the backup data.
## Location of backup repository
The backup repository can be located on the local file system, or on an external S3 storage. Currently this library supports AWS / AmazonS3 as external storage for the backup repository. More details about the Amazon Bucket configuration in the restic documentation https://restic.readthedocs.io/en/latest/080_examples.html#setting-up-restic-with-amazon-s3
## Overview commands
This gives you an overview of the possible methods of the framework. The default value for repositoryLocationTypes is local.
### MuckiRestic\Library\Backup\Backup::_[method]_;
```php
[method]
...
```
| Method | Parameter variable name [type of variable] | Description |
|:-------------------|:------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|
| createRepository() | $overwrite[bool],
$repositoryLocationTypes[RepositoryLocationTypes] (optional) | Creates a new backup repository |
| createBackup() | $repositoryLocationTypes[RepositoryLocationTypes] (optional) | Creates a backup with and creates a new snapshot in the backup repository |
| checkBackup() | $repositoryLocationTypes[RepositoryLocationTypes] (optional) | Checks a repository and reads all data for testing |
### MuckiRestic\Library\Backup\Manage::_[method]_;
```php
[method]
...
```
| Method | Parameter variable name [type of variable] | Description |
|:---------------------|:-------------------------------------------------------------|:--------------------------------------------------------------------------------|
| getSnapshots() | $repositoryLocationTypes[RepositoryLocationTypes] (optional) | Get a list of all snapshots in specific repository |
| removeSnapshots() | $repositoryLocationTypes[RepositoryLocationTypes] (optional) | Removes snapshots by snapshot ids |
| removeSnapshotById() | $repositoryLocationTypes[RepositoryLocationTypes] (optional) | Removes a snapshot by specific snapshot id |
| executePrune() | $repositoryLocationTypes[RepositoryLocationTypes] (optional) | Performance a clean up of old items after a remove command. Its saved hd space. |
| getRepositoryStats() | $repositoryLocationTypes[RepositoryLocationTypes] (optional) | Get a list of statistic values of a specific repository |
### MuckiRestic\Library\Restore::_[method]_;
```php
[method]
...
```
| Method | Parameter variable name [type of variable] | Description |
|:-------------------|:------------------------------------------------------------------------------------|:-----------------------------------------|
| createRestore() | $overwrite[bool],
$repositoryLocationTypes[RepositoryLocationTypes] (optional) | Creates a restore of a specific snapshot |
## Create a new backup repository
You will need first the backup object of the library, for to use the **createRepository** method. Import this class with `use MuckiRestic\Library\Backup;`. The Backup-class has a static `create`-method for to get the Backup object, like this `$backupClient = Backup::create();`. With this create, you have access to all the Backup methods. The `$backupClient->createRepository()` method initialize a new repository and need the required parameters _password_ and the _repositoryPath_. The repositoryPath is where the backup data will be stored and the password is used to encrypt the backup data. It's required for all operations on the repository. It has to be set by the two setting methods `$backupClient->setRepositoryPassword('1234')` and `$backupClient->setRepositoryPath('./path_to_repository')`
Optionally you can set the path for the restic binary, with `$backupClient->setBinaryPath('./bin/restic_0.17.3_linux_386')`. This is necessary if the restic binary is not installed in the local system.
The method `createRepository()` returns the object `ResultEntity`.
The method `getOutput` of the object `ResultEntity` returns the output of the restic command. If an error occurs, an exception will be thrown.
### Example for local repository
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$backupClient->setRepositoryPassword('12345%ASDEee'); //required
$backupClient->setRepositoryPath('./path_to_repository'); //required
echo $backupClient->createRepository()->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
### Example for Amazon S3 storage
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$backupClient->setRepositoryPassword('12345%ASDEee'); //required
$backupClient->setAwsAccessKeyId('AABBCCDDYUI4T123WIZY'); //required
$backupClient->setAwsSecretAccessKey('xLqWLrN1yfrJ+r2zlnpoMY3eDXdHmdnne8T+Y2XZ'); //required
$backupClient->setAwsRegion('eu-central-1'); //required
$backupClient->setAwsS3Endpoint('s3:https://s3.amazonaws.com/my-restic-bucket'); //required
$backupClient->setAwsS3BucketName('my-restic-bucket'); //required
echo $backupClient->createRepository(RepositoryLocationTypes::AWSS3)->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
## Create a backup
Next step, create a backup into the repository by using the method `$backupClient->createBackup()`. Also, this method will returns the object `ResultEntity`. The backup path is required for the backup operation. It has to be set by the method `$backupClient->setBackupPath('./path_to_backup_folder')`.
Every backup process creates a new **snapshot** of the backup data in the repository. These **snapshots** are represented by an individually hash string.
### Example for local repository
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$backupClient->setRepositoryPassword('12345%ASDEee'); //required
$backupClient->setRepositoryPath('./path_to_repository'); //required
$backupClient->setBackupPath('./path_to_backup_folder'); //required
echo $backupClient->createBackup()->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
### Example for Amazon S3 storage
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$backupClient->setRepositoryPassword('12345%ASDEee'); //required
$backupClient->setBackupPath('./path_to_backup_folder'); //required
$backupClient->setAwsAccessKeyId('AABBCCDDYUI4T123WIZY'); //required
$backupClient->setAwsSecretAccessKey('xLqWLrN1yfrJ+r2zlnpoMY3eDXdHmdnne8T+Y2XZ'); //required
$backupClient->setAwsRegion('eu-central-1'); //required
$backupClient->setAwsS3Endpoint('s3:https://s3.amazonaws.com/my-restic-bucket'); //required
$backupClient->setAwsS3BucketName('my-restic-bucket'); //required
echo $backupClient->createBackup(RepositoryLocationTypes::AWSS3)->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
## Check the backup
After the backup process, it makes sense to check the backup data. The method `$backupClient->checkBackup()` will return the object `ResultEntity`. The method `getOutput` of the object `ResultEntity` returns the output of the restic command simple as string. If an error occurs, an exception will be thrown.
### Example for local repository
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$backupClient->setRepositoryPassword('1234'); //required
$backupClient->setRepositoryPath('./path_to_repository'); //required
echo $backupClient->checkBackup()->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
### Example for Amazon S3 storage
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$backupClient->setRepositoryPassword('1234'); //required
$backupClient->setAwsAccessKeyId('AABBCCDDYUI4T123WIZY'); //required
$backupClient->setAwsSecretAccessKey('xLqWLrN1yfrJ+r2zlnpoMY3eDXdHmdnne8T+Y2XZ'); //required
$backupClient->setAwsRegion('eu-central-1'); //required
$backupClient->setAwsS3Endpoint('s3:https://s3.amazonaws.com/my-restic-bucket'); //required
$backupClient->setAwsS3BucketName('my-restic-bucket'); //required
echo $backupClient->checkBackup(RepositoryLocationTypes::AWSS3)->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
## Manage backups
The library provides methods for to manage backups. Import this class with `use MuckiRestic\Library\Manage;`.
## Get list of snapshots
You can get list of all snapshots of a repository with the method `$manageClient->getSnapshots()`. The method `getSnapshots` returns the object `ResultEntity`. The method `getOutput` of the object `ResultEntity` returns the output of the restic command simple as string. If an error occurs, an exception will be thrown.
### Example for local repository
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$manageClient->setRepositoryPassword('1234'); //required
$manageClient->setRepositoryPath('./path_to_repository'); //required
echo $manageClient->getSnapshots()->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
### Example for Amazon S3 storage
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$manageClient->setRepositoryPassword('1234'); //required
$manageClient->setAwsAccessKeyId('AABBCCDDYUI4T123WIZY'); //required
$manageClient->setAwsSecretAccessKey('xLqWLrN1yfrJ+r2zlnpoMY3eDXdHmdnne8T+Y2XZ'); //required
$manageClient->setAwsRegion('eu-central-1'); //required
$manageClient->setAwsS3Endpoint('s3:https://s3.amazonaws.com/my-restic-bucket'); //required
$manageClient->setAwsS3BucketName('my-restic-bucket'); //required
echo $manageClient->getSnapshots(RepositoryLocationTypes::AWSS3)->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
## Remove snapshot by id
You can remove a snapshot of a repository by id with the method `$manageClient->getSnapshots()`. The method `getSnapshots` returns the object `ResultEntity`. The method `getOutput` of the object `ResultEntity` returns the output of the restic command simple as string. If an error occurs, an exception will be thrown.
### Example
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$manageClient->setRepositoryPassword('1234'); //required
$manageClient->setRepositoryPath('./path_to_repository'); //required
$manageClient->setSnapshotId('snapshot_id'); //required
echo $manageClient->removeSnapshotById()->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
### Example for Amazon S3 storage
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$manageClient->setRepositoryPassword('1234'); //required
$manageClient->setSnapshotId('snapshot_id'); //required
$manageClient->setAwsAccessKeyId('AABBCCDDYUI4T123WIZY'); //required
$manageClient->setAwsSecretAccessKey('xLqWLrN1yfrJ+r2zlnpoMY3eDXdHmdnne8T+Y2XZ'); //required
$manageClient->setAwsRegion('eu-central-1'); //required
$manageClient->setAwsS3Endpoint('s3:https://s3.amazonaws.com/my-restic-bucket'); //required
$manageClient->setAwsS3BucketName('my-restic-bucket'); //required
echo $manageClient->removeSnapshotById(RepositoryLocationTypes::AWSS3)->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
## Remove old snapshots
You can remove old snapshots of a repository with the method `$manageClient->removeSnapshots()`. This is kind a like a cleanup run for the repository. The method `removeSnapshots` returns as always the object `ResultEntity`. The method `getOutput` of the object `ResultEntity` returns the output of the restic command simple as string. If an error occurs, an exception will be thrown.
This cleanup run needs to be setup with the keep-parameters, which defined the number of daily, weekly, monthly and yearly snapshots to keep. The method `setKeepDaily(int $keepDaily)`, `setKeepWeekly(int $keepWeekly)`, `setKeepMonthly(int $keepMonthly)` and `setKeepYearly(int $keepYearly)` are used to set the keep-parameters.
### default keep-parameters
| Parameter | value |
|:----------|:------|
| $keepDaily | 7 |
| $keepWeekly | 5 |
| $keepMonthly | 12 |
| $keepYearly | 75 |
More details about the keep-parameters you can find in the restic documentation https://restic.readthedocs.io/en/latest/060_forget.html#removing-snapshots-according-to-a-policy
### Example for local repository
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$manageClient->setRepositoryPassword('1234'); //required
$manageClient->setRepositoryPath('./path_to_repository'); //required
$manageClient->setKeepDaily(1); //optional
$manageClient->setKeepWeekly(2); //optional
$manageClient->setKeepMonthly(4); //optional
$manageClient->setKeepYearly(5); //optional
echo $manageClient->removeSnapshots()->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
### Example for Amazon S3 storage
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$manageClient->setRepositoryPassword('1234'); //required
$manageClient->setKeepDaily(1); //optional
$manageClient->setKeepWeekly(2); //optional
$manageClient->setKeepMonthly(4); //optional
$manageClient->setKeepYearly(5); //optional
$manageClient->setAwsAccessKeyId('AABBCCDDYUI4T123WIZY'); //required
$manageClient->setAwsSecretAccessKey('xLqWLrN1yfrJ+r2zlnpoMY3eDXdHmdnne8T+Y2XZ'); //required
$manageClient->setAwsRegion('eu-central-1'); //required
$manageClient->setAwsS3Endpoint('s3:https://s3.amazonaws.com/my-restic-bucket'); //required
$manageClient->setAwsS3BucketName('my-restic-bucket'); //required
echo $manageClient->removeSnapshots(RepositoryLocationTypes::AWSS3)->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
## Restore a backup
You can restore a backup from a repository with the method `$restoreClient->restoreBackup()`. The method `restoreBackup` returns also the object `ResultEntity`. The method `getOutput` of the object `ResultEntity` returns the output of the restic command simple as string. If an error occurs, an exception will be thrown.
As default the method `restoreBackup` will restore the latest snapshot. Optionally you can set the snapshot hash with the method `setRestoreItem(string $snapshotHash)`. The snapshot hash you can get from the method `getSnapshots`.
### Example for local repository
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$restoreClient->setRepositoryPassword('1234'); //required
$restoreClient->setRepositoryPath('./path_to_repository'); //required
$restoreClient->setRestoreTarget('./path_to_restore_folder'); //required
$restoreClient->setRestoreItem('snapshot_hash'); //optional
echo $restoreClient->createRestore()->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
### Example for Amazon S3 storage
```php
setBinaryPath('./bin/restic_0.17.3_linux_386'); //optional
$restoreClient->setRepositoryPassword('1234');
$restoreClient->setRestoreTarget('./path_to_restore_folder');
$restoreClient->setRestoreItem('snapshot_hash'); //optional
$restoreClient->setAwsAccessKeyId('AABBCCDDYUI4T123WIZY'); //required
$restoreClient->setAwsSecretAccessKey('xLqWLrN1yfrJ+r2zlnpoMY3eDXdHmdnne8T+Y2XZ'); //required
$restoreClient->setAwsRegion('eu-central-1'); //required
$restoreClient->setAwsS3Endpoint('s3:https://s3.amazonaws.com/my-restic-bucket'); //required
$restoreClient->setAwsS3BucketName('my-restic-bucket'); //required
echo $restoreClient->createRestore(RepositoryLocationTypes::AWSS3)->getOutput();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
}
```
## Use as cli app
Checkout the App folder for to run as cli command
```shell
bin/console muwa:restic:client --help
```
Get version of restic binary
```shell
bin/console muwa:restic:client --Version
```
### Init a new backup repository
```shell
bin/console muwa:restic:client --Init
```
- _Repository_ - Free of choice, where the backup data will be stored.
- _Password_ - Password for the backup repository, which is used to encrypt the backup data. It's required for all operations on the repository.
Init a new backup repository
### Create a backup
```shell
bin/console muwa:restic:client --Backup
```
- _Repository_ - Path to the backup repository
- _Password_ - Password for the backup repository.
- _Backup_ - Path to data which should be backed up. This can be a single file or a folder. If the path is a folder, all files and subfolders will be backed up.
### Check the backup, by getting a list of all snapshots
```shell
bin/console muwa:restic:client --Snapshots
```
- _Repository_ - Path to the backup repository
- _Password_ - Password for the backup repository.
### Remove specific snapshot
```shell
bin/console muwa:restic:client --Snapshots -r --snapshotId
```
- _Repository_ - Path to the backup repository
- _Password_ - Password for the backup repository.
### Remove old snapshots
```shell
bin/console muwa:restic:client --Forget
```
- _Repository_ - Path to the backup repository
- _Password_ - Password for the backup repository.
# Testing
Run phpunit tests
```shell
./vendor/bin/phpunit --configuration=phpunit.xml
./vendor/bin/phpunit --configuration=phpunit_without_integration.xml
```
Run phpstan tests
```shell
composer run-script phpstan
```
# License
MIT License (MIT). Please see LICENSE File for more information.
# Notice
If you run muckiware/restic on a ddev/Docker environment, you could get a **read/error** of the backup files. In this case, check the mutagen status, and enable the mutagen sync. This library is only checked on a Linux and MacOS environment. All components are also available for Windows, but no warranty that is also working on a Windows environment.