https://github.com/dev-ritik/vault
Symmetric Key based data backup & recovery utility
https://github.com/dev-ritik/vault
Last synced: about 1 year ago
JSON representation
Symmetric Key based data backup & recovery utility
- Host: GitHub
- URL: https://github.com/dev-ritik/vault
- Owner: dev-ritik
- Created: 2020-04-11T19:37:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-07T16:50:14.000Z (over 5 years ago)
- Last Synced: 2025-03-25T14:45:03.090Z (about 1 year ago)
- Language: Shell
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vault
Symmetric Key based data backup & recovery utility. Help to encrypt confidential files before backing up.
(Basically reinventing the wheel!)
Pass is used to store the passphrase.
## Installation
- Clone the repo
- Run `./install.sh` for setting up the project
- Use `~/.config/vault/.targets` for adding paths for files to encrypt. Use `!`for excluding files.
(Supports `#` for commenting and `*` for multiple files)
- Add `pwd` to the path and run `./vault` for interacting
Sample `.targets` file
```
# Super secret file
/home/ritik/Desktop/secret_file.txt
/home/ritik/Desktop/secret_folder/* #Folder with secret files
!*.png #Png files are not important
```
## Usage
Allowed options:
```
update Update the index and encrypt the files
decrypt Decrypt required files to a location
files Location of files stored available to be shared
all else Print this message
```
For decrypt suboptions are,
```
-o, --output Output path to restore files to (default pwd)
-b, --backup Set of paths to restore files from. Use /* for all
```
## Example
- For encrypting files,
```bash
./vault.sh update
```
- For decrypting your files
```bash
./vault.sh decrypt -b /* -o /home/ritik/Desktop
```
## Dependencies
- `pass` - safely encrypts passwords (required at install).
- `gpg`- (or `gpg2`)- For encrypting and decrypting files.
- `find` - For finding (modified) files.
- `python`- For complex operations (TODO)