Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dtgoitia/direnv-backup
https://github.com/dtgoitia/direnv-backup
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dtgoitia/direnv-backup
- Owner: dtgoitia
- License: gpl-3.0
- Created: 2022-07-25T19:48:30.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-08-24T19:13:07.000Z (over 2 years ago)
- Last Synced: 2024-10-28T13:55:50.249Z (2 months ago)
- Language: Python
- Size: 144 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# direnv-backup
Tool to backup/restore direnv files.
Purely written in Python.
## Rationale
If you use [direnv][1] (*), you have probably built up a few dozens of carefully crafted `.envrc` files over time that now quietly live somewhere scattered across your projects directory making your developer experience much nicer almost for free.
Wouldn't it be great if you could back up all those precious files?
[direnv-backup][2] is a simple CLI utility to backup/restore your direnv files. It is designed to be [config driven](#configuration). Just drop your dotfiles, install direnv-backup and you are ready to go.
Optionally, you can encrypt your backups using [GPG][3]. I strongly suggest you to enable encryption.
\*: if you don't use it yet, you should definitely try it.
## Installation
* Install with your AUR package manager:
```bas
$ aurman -S direnv-backup
```
* Create mandatory config file, see [how to](#configuration).
* Enable automatic backups, see [how to](#automatic-backups).
## Configuration
`direnv-backup` is driven by configuration. Create a file at `~/.config/direnv-backup/config.json` and add the following:
```json
{
"root_dir": "/home/janedoe/projects",
"exclude": [
"__pycache_ _",
".git",
".venv",
"node_modules"
],
"backup_dir": "/home/janedoe/my-direnv-backups",
"encrypt_backup": true,
"encryption_recipient": "[email protected]"
}
```
where:
* `root_dir` (string): path where the backup command looks for direnv files to back them up, and the reference the restore command uses to know where to put the direnv files back.
* `exclude` (string list): list of directory names to skip during the `root_dir` traversal. Suggestion: populate this list with big directories that do not contain direnv files to considerably **reduce the execution time**.
* `backup_dir` (string): path where the backups will be stored.
* `encrypt_backup` (boolean, _optional_): if `true` the backups will be encrypted. Requires `encryption_recipient`.
* `encryption_recipient` (string, _optional_): email set in the GPG key pair that will be used to encrypt (on back up) and decrypt (on restore) the backups.
## Automatic backups
1. Create a user service unit: copy [this file](./systemd/direnv-backup.service) to `~/.config/systemd/user/direnv-backup.service`.
2. Create a user timer unit: copy [this file](./systemd/direnv-backup.timer) to `~/.config/systemd/user/direnv-backup.timer`.
3. Enable the timer unit:
```bash
$ systemd --user enable direnv-backup.timer
```
To tune how frequently automatic backups are created, edit the timer unit and set `OnUnitActiveSec` to the amount of seconds you want between each backup:
```diff
- OnUnitActiveSec=3600
+ OnUnitActiveSec=1234567
```
You might need to ask systemd to reload units after this change.
## Commands
**IMPORTANT**: a working [configuration](#configuration) must be in place.
* Create a new backup:
```shell
direnv-backup --config=/path/to/config.json
```
* Restore the last backup:
```shell
direnv-restore --config=/path/to/config.json
```
## Development
See [development docs](./docs/development.md).
[1]: https://direnv.net/ "direnv official site"
[2]: https://aur.archlinux.org/packages/direnv-backup "AUR direnv-backup"
[3]: https://www.gnupg.org/ "GnuPG official site"