PHPackages                             linkorb/snapshot - 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. [Database & ORM](/categories/database)
4. /
5. linkorb/snapshot

ActiveLibrary[Database & ORM](/categories/database)

linkorb/snapshot
================

Database snapshot application

v1.12.0(6y ago)31762[3 PRs](https://github.com/linkorb/snapshot/pulls)MITPHP

Since Oct 2Pushed 2y ago3 watchersCompare

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

READMEChangelog (10)Dependencies (5)Versions (24)Used By (0)

Snapshot
========

[](#snapshot)

Mysql snapshot utility

Features
--------

[](#features)

- Backup single database, or all databases on a server, to Amazon S3
- Compressesion
- Encryption (GPG)
- Supports multiple servers in single config
- Supports multiple storage backends in single config
- Simple database restore
- Lists remote snapshots with wildcards

Configuration
-------------

[](#configuration)

Snapshot is configured using a `snapshot.yml` file.

The file will be automatically loaded from the current working directory, or from `/etc/snapshot.yml`.

You can also pass `--config` or `-c` to specify the exact config filename you wish to use.

To get you started, simply run:

```
cp snapshot.yml.dist snapshot.yml

```

and edit `snapshot.yml` to fit your environment

### Example snapshot.yml

[](#example-snapshotyml)

In the following config you'll find 2 configured database servers (`server-a` and `server-b`), and one storage backend (`store1`):

```
workdir: /snapshot

servers:

  server-a:
    username: root
    password: super_secret_password
    address: 10.0.0.100
    port: 3306

  server-b:
    username: root
    password: mega_secret_password
    address: 10.0.0.101
    port: 3306

storage:
  store1:
    type: s3
    region: eu-west-1
    access_key: HELLO
    secret_key: SHHHHHHH
    bucket: my_bucket_name
    prefix: "snapshot/"
    gpg_password: s3cr3t
```

Usage examples:
---------------

[](#usage-examples)

### Backing up a whole server:

[](#backing-up-a-whole-server)

The following command will backup all databases on `server-a` to `store1`.

```
bin/snapshot server:backup server-a store1

```

### Backing up a single database:

[](#backing-up-a-single-database)

The following command will backup database `my_db` on `server-a` to `store1`.

```
bin/snapshot database:backup server-a my_db store1

```

### List remote snapshots

[](#list-remote-snapshots)

The following command will list all snapshots in `store1`.

```
bin/snapshot snapshot:list store1

```

The following command will list all snapshots in `store1` matching a filter.

```
bin/snapshot snapshot:list store1 snapshot-a/*/my_db

```

Restoring backups
-----------------

[](#restoring-backups)

The following command will restore a backup of snapshot `server-a/20160101/my_db` from `store1` onto `server-b`:

```
bin/snapshot snapshot:restore store1 server-b server-a/20160101/my_db

```

License
-------

[](#license)

MIT. Please refer to the [license file](LICENSE.md) for details.

Brought to you by the LinkORB Engineering team
----------------------------------------------

[](#brought-to-you-by-the-linkorb-engineering-team)

[![](https://camo.githubusercontent.com/62fb66b034de7ea7fca9fd9776424b5348daa76ef8622caf92c2f7622003e5ef/687474703a2f2f7777772e6c696e6b6f72622e636f6d2f642f6d6574612f74696572312f696d616765732f6c696e6b6f7262656e67696e656572696e672d6c6f676f2e706e67)](https://camo.githubusercontent.com/62fb66b034de7ea7fca9fd9776424b5348daa76ef8622caf92c2f7622003e5ef/687474703a2f2f7777772e6c696e6b6f72622e636f6d2f642f6d6574612f74696572312f696d616765732f6c696e6b6f7262656e67696e656572696e672d6c6f676f2e706e67)
Check out our other projects at [linkorb.com/engineering](http://www.linkorb.com/engineering).

Btw, we're hiring!

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity73

Established project with proven stability

 Bus Factor1

Top contributor holds 91.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~61 days

Recently: every ~183 days

Total

20

Last Release

2335d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/1db66b320db18b8036ea68211b7d8a39e7c6da97e6fd29f59a50380ebb69d0bb?d=identicon)[joostfaassen](/maintainers/joostfaassen)

---

Top Contributors

[![joostfaassen](https://avatars.githubusercontent.com/u/411113?v=4)](https://github.com/joostfaassen "joostfaassen (33 commits)")[![prajapati-kaushik](https://avatars.githubusercontent.com/u/10140681?v=4)](https://github.com/prajapati-kaushik "prajapati-kaushik (3 commits)")

---

Tags

snapshotdatabasebackupmysqllinkorb

### Embed Badge

![Health badge](/badges/linkorb-snapshot/health.svg)

```
[![Health](https://phpackages.com/badges/linkorb-snapshot/health.svg)](https://phpackages.com/packages/linkorb-snapshot)
```

###  Alternatives

[spatie/laravel-backup

A Laravel package to backup your application

6.0k21.8M186](/packages/spatie-laravel-backup)[rah/danpu

Zero-dependency MySQL dump library for easily exporting and importing databases

64401.8k10](/packages/rah-danpu)[phelium/mysql-backup

Backup easily your MySQL database !

278.2k2](/packages/phelium-mysql-backup)[smrtr/mysql-version-control

A crude version control system for mysql written in php

221.4k](/packages/smrtr-mysql-version-control)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)