PHPackages                             muckiware/restic - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File & Storage](/categories/file-storage)
4. /
5. muckiware/restic

ActiveLibrary[File & Storage](/categories/file-storage)

muckiware/restic
================

php client for restic backup tool

v1.4.1(4mo ago)2960↓50%[3 issues](https://github.com/muckiware/restic/issues)1MITPHPPHP ^8.1CI passing

Since Dec 15Pushed 4mo ago1 watchersCompare

[ Source](https://github.com/muckiware/restic)[ Packagist](https://packagist.org/packages/muckiware/restic)[ Docs](https://github.com/muckiware/restic)[ RSS](/packages/muckiware-restic/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (8)Dependencies (8)Versions (16)Used By (1)

muckiware/restic
================

[](#muckiwarerestic)

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.

[![Latest Stable Version](https://camo.githubusercontent.com/f4e72b8ae8d7c0d8451a97b8d5c1d6a9420fd62fd0de4e72addd1d02ae4b5ede/687474703a2f2f706f7365722e707567782e6f72672f6d75636b69776172652f7265737469632f76)](https://packagist.org/packages/muckiware/restic)[![Total Downloads](https://camo.githubusercontent.com/264ae037f6e36a0cedd449ffa6726ca6fe402a1bffa64719620da91eb028f5ce/687474703a2f2f706f7365722e707567782e6f72672f6d75636b69776172652f7265737469632f646f776e6c6f616473)](https://packagist.org/packages/muckiware/restic)[![PHP Version Require](https://camo.githubusercontent.com/868ace5e27745b7203ccec89d2e20b26f0bdf5b2a9ae697c86fa96bba5cc4fd5/687474703a2f2f706f7365722e707567782e6f72672f6d75636b69776172652f7265737469632f726571756972652f706870)](https://packagist.org/packages/muckiware/restic)[![Dependents](https://camo.githubusercontent.com/22de05d53f05defd2fff0a480a7d8fff311cee957b412cb2336bd703a10840e2/687474703a2f2f706f7365722e707567782e6f72672f6d75636b69776172652f7265737469632f646570656e64656e7473)](https://packagist.org/packages/muckiware/restic)[![License](https://camo.githubusercontent.com/4e088d0216495a0bdeec2fb4b97afe19dcf5235f61f598cedc9ec837a7d015d1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f73686f70776172652f73686f70776172652e737667)](https://github.com/shopware/shopware/blob/trunk/LICENSE)

Requirements
============

[](#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](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
============

[](#installation)

```
composer require muckiware/restic
```

Usage
=====

[](#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
-----------------------------

[](#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](https://restic.readthedocs.io/en/latest/080_examples.html#setting-up-restic-with-amazon-s3)

Overview commands
-----------------

[](#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\]*;

[](#muckiresticlibrarybackupbackupmethod)

```