https://github.com/nikelborm/archive-compress-encrypt-and-back
Simple script to archive (tar) compress (zstd) and encrypt(gpg) and do the opposite to folders
https://github.com/nikelborm/archive-compress-encrypt-and-back
bash gpg tar zstd
Last synced: 4 months ago
JSON representation
Simple script to archive (tar) compress (zstd) and encrypt(gpg) and do the opposite to folders
- Host: GitHub
- URL: https://github.com/nikelborm/archive-compress-encrypt-and-back
- Owner: nikelborm
- License: gpl-3.0
- Created: 2023-10-07T15:41:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-07T17:13:13.000Z (over 1 year ago)
- Last Synced: 2025-01-07T19:56:31.473Z (5 months ago)
- Topics: bash, gpg, tar, zstd
- Language: Shell
- Homepage:
- Size: 25.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# main.sh
`main.sh` is a Bash script that provides two functions for creating and extracting encrypted compressed archives. The script uses the `tar`, `zstd`, and `gpg` utilities to create and extract archives.
## Usage
```
Usage: main.sh do_tar_zstd_gpg source_dir dest_file
main.sh undo_tar_zstd_gpg source_file dest_dir
do_tar_zstd_gpg: Create a tar archive, compress with zstd, and encrypt with gpg
undo_tar_zstd_gpg: Decrypt, decompress, and extract files from an encrypted compressed archive
source_dir: The source directory to be archived
source_file: The source archive file to be extracted
dest_file: The destination archive file to be created
dest_dir: The destination directory for the extracted files
Examples:
Put all files and dirs which are inside ~/.local/share/TelegramDesktop directory
into encrypted compressed archive ~/tg.tar.zst.gpg:
./main.sh do_tar_zstd_gpg ~/.local/share/TelegramDesktop ~/tg.tar.zst.gpg
Put all files and dirs which are inside encrypted compressed archive ~/tg.tar.zst.gpg
into directory ~/.local/share/TelegramDesktop:
rm -rf ~/.local/share/TelegramDesktop; ./main.sh undo_tar_zstd_gpg ~/tg.tar.zst.gpg ~/.local/share/TelegramDesktop
Notes:
Env
The GPG recipient email or key ID can be set using the GPG_RECIPIENT environment variable. For example:
GPG_RECIPIENT="[email protected]" main.sh do_tar_zstd_gpg /path/to/source_dir /path/to/dest_file
Archiving
Script does not check if the destination file exists, so it is recommended
that you manually delete the old archive before creating a new one.
Script does not add any extensions, so it is recommended
that you manually add .tar.zst.gpg to the archive file
Extracting
Script does not handle conflicts when extracting files, so it is recommended
that you manually delete the content of destination directory before extracting.
```
## Functions
### `do_tar_zstd_gpg`
The `do_tar_zstd_gpg` function creates an encrypted compressed archive of a directory. The function takes two arguments:
- `source_dir`: The source directory to be archived.
- `dest_file`: The destination file for the archive.
### `undo_tar_zstd_gpg`
The `undo_tar_zstd_gpg` function extracts an encrypted compressed archive to a directory. The function takes two arguments:
- `source_file`: The source archive file to be extracted.
- `dest_dir`: The destination directory for the extracted files.
## Environment Variables
### `GPG_RECIPIENT`
The `GPG_RECIPIENT` environment variable sets the recipient email or key ID for the `gpg` encryption. The default value is `"[email protected]"`. To set a different recipient, export the `GPG_RECIPIENT` variable before invoking the script.
## License
This script is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.