https://github.com/parlaynu/snappit
Create and manage manual filesystem snapshots.
https://github.com/parlaynu/snappit
Last synced: 6 months ago
JSON representation
Create and manage manual filesystem snapshots.
- Host: GitHub
- URL: https://github.com/parlaynu/snappit
- Owner: parlaynu
- License: mit
- Created: 2025-05-18T06:42:10.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-05-28T21:23:14.000Z (8 months ago)
- Last Synced: 2025-07-03T03:38:50.779Z (7 months ago)
- Language: Go
- Homepage:
- Size: 69.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Directory Snapshots
This project contains a tool to create and restore user-managed snapshots of filesystem directories.
It is derived from the project [s3backup](https://github.com/parlaynu/s3backup), rearranging the core operators
and algorithm to work for user-space snapshots instead of backups.
The snapshot is configured through a yaml configuration file, with an example shown [here](config/config.yaml).
The default location for the configuration file is `~/.config/snappit/config.yaml`; this can be overridden
on the command line.
## Concepts
Arena - this is the area that contains the snapshots. There are multiple snapshots in an arena.
The arena is defined in the configuration file.
Snapshot - this contains one or more archives as defined in the configuration file. The snapshot
name is a directory within the arena.
Archive - this is the basic unit that is snapshotted. The archives are defined in the config file.
It consists of a manifest file with the full list of files included in the snapshot
along with each file's metadata such as size, modify time and, importantly, the content hash.
Arena data - the actual files are stored in the data location within the arena in files named
by the content hash of the file. This provides deduplication by default. The content hash in the
manifest file is used to locate the file within the data directory.
## Quick Start
For a quick demonstration of it's use, take the example configuration file and customise it to create
some snapshots.
To create the baseline snapshot, run:
$ snappit create baseline
Then modify some files in the source directories and create a new snapshot:
$ snappit create v001
To list the snapshots available, run the list command:
$ snappit list
To restore to the baseline snapshot:
$ snappit restore baseline
This last command will restore the source directories to how they were when the baseline
snapshot was created.