Download the PHP package muckiware/restic without Composer

On this page you can find all versions of the php package muckiware/restic. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of muckiware/restic

Informations about the package restic

muckiware/restic

PHP client for restic backup tool. This library provides a simple way to create and manage backups with restic. It uses repositories as storage for backups.

Requirements

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.

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

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

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

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

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

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

Class MuckiRestic\Entity\Result\ResultEntity

The ResultEntity class is part of the MuckiRestic library and extends the DataSet class. It represents the result of a backup operation and contains various properties and methods to access and manipulate the result data.

Properties

Methods

getSnapshots(): ?SnapshotsResultEntity

Returns the snapshot results.

setSnapshots(SnapshotsResultEntity $snapshots): void

Sets the snapshot results.

getFiles(): ?FilesDirsResultEntity

Returns the file results.

setFiles(FilesDirsResultEntity $files): void

Sets the file results.

getDirectories(): ?FilesDirsResultEntity

Returns the directory results.

setDirectories(FilesDirsResultEntity $directories): void

Sets the directory results.

getProcessed(): ?array

Returns the processed data.

setProcessed(array $processed): void

Sets the processed data.

addProcessed(string $processed): void

Adds a processed data entry.

getCommandLine(): ?string

Returns the command line used for the operation.

setCommandLine(?string $commandLine): void

Sets the command line used for the operation.

getStatus(): ?string

Returns the status of the operation.

setStatus(?string $status): void

Sets the status of the operation.

getStartTime(): ?float

Returns the start time of the operation.

setStartTime(?float $startTime): void

Sets the start time of the operation.

getEndTime(): ?float

Returns the end time of the operation.

setEndTime(?float $endTime): void

Sets the end time of the operation.

getDuration(): ?float

Calculates and returns the duration of the operation.

setDuration(): void

Calculates and sets the duration of the operation.

getOutput(): ?string

Returns the output of the operation.

setOutput(?string $output): void

Sets the output of the operation.

getResticResponse(): mixed

Returns the response from the restic command.

setResticResponse(mixed $resticResponse): void

Sets the response from the restic command.

Example as cli app

Checkout the App folder for to run as cli command

Testing

Run phpunit tests

Run phpstan tests

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.

All versions of restic with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
netresearch/jsonmapper Version ^5.0
symfony/process Version ^5.0|^6.0|^7.0
symfony/console Version ^5.0|^6.0|^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package muckiware/restic contains the following files

Loading the files please wait ....