3852e305b6
The script provides a convenient way to load environment config, deal
with profiles and act as a pass-through to restic. The overall thing is
to improve the UX when running restic, integrating the features this
project provides.
## Note
The script itself is a very simple thing.
The command line parser is auto-generated using docopt.sh driven from
the script's DOC. It can be refreshed upon DOC changes with:
`docopt.sh path/to/resticw`.
## How to use it
### Examples
```console
sudo resticw stats latest
sudo resticw -p profileA snapshots
```
### Help
```console
❯ resticw --help
A little wrapper over restic just to handle profiles and environment loading.
It loads the backup profile/environment in a subshell to avoid any credential leak (Note: Run it with sudo so it can load the environment).
Usage:
resticw [options] <restic_arguments>
The restic_arguments is just the regular unwrapped restic arguments, e.g. stats latest
Options:
-p --profile=<name> Specify the profile to load or use default [default: default].
Examples:
sudo resticw --profile profileA snapshots
sudo resticw stats latest # this will use the profile: default
```
Co-authored-by: Erik Westrup <erik.westrup@gmail.com>
61 lines
2.3 KiB
Makefile
61 lines
2.3 KiB
Makefile
# Not file targets.
|
|
.PHONY: help install install-scripts install-conf install-systemd uninstall
|
|
|
|
### Macros ###
|
|
SRCS_SCRIPTS = $(filter-out %cron_mail, $(wildcard usr/local/sbin/*))
|
|
# $(sort) remove duplicates that comes from running make install >1 times.
|
|
SRCS_CONF = $(sort $(patsubst %.template, %, $(wildcard etc/restic/*)))
|
|
SRCS_SYSTEMD = $(wildcard etc/systemd/system/*)
|
|
|
|
# To change the installation root path, set the PREFIX variable in your shell's environment, like:
|
|
# $ PREFIX=/usr/local make install
|
|
# $ PREFIX=/tmp/test make install
|
|
DEST_SCRIPTS = $(PREFIX)/usr/local/sbin
|
|
DEST_CONF = $(PREFIX)/etc/restic
|
|
DEST_SYSTEMD = $(PREFIX)/etc/systemd/system
|
|
|
|
INSTALLED_FILES = $(addprefix $(PREFIX)/, $(SRCS_SCRIPTS) $(SRCS_CONF) $(SRCS_SYSTEMD))
|
|
|
|
### Targets ###
|
|
# target: all - Default target.
|
|
all: install
|
|
|
|
# target: help - Display all targets.
|
|
help:
|
|
@egrep "#\starget:" [Mm]akefile | sed 's/\s-\s/\t\t\t/' | cut -d " " -f3- | sort -d
|
|
|
|
# target: install - Install all files
|
|
install: install-scripts install-conf install-systemd
|
|
|
|
|
|
# target: install-scripts - Install executables.
|
|
install-scripts:
|
|
install -d $(DEST_SCRIPTS)
|
|
install -m 0744 $(filter-out %/resticw, $(SRCS_SCRIPTS)) $(DEST_SCRIPTS)
|
|
install -m 0755 usr/local/sbin/resticw $(DEST_SCRIPTS)
|
|
|
|
# Copy templates to new files with restricted permissions.
|
|
# Why? Because the non-template files are git-ignored to prevent that someone who clones or forks this repo checks in their sensitive data like the B2 password!
|
|
etc/restic/_global.env etc/restic/default.env etc/restic/pw.txt:
|
|
install -m 0600 $@.template $@
|
|
|
|
# target: install-conf - Install restic configuration files.
|
|
# will create these files locally only if they don't already exist
|
|
# `|` means that dependencies are order-only, i.e. only created if they don't already exist.
|
|
install-conf: | $(SRCS_CONF)
|
|
install -d $(DEST_CONF)
|
|
install -b -m 0600 $(SRCS_CONF) $(DEST_CONF)
|
|
$(RM) etc/restic/_global.env etc/restic/default.env etc/restic/pw.txt
|
|
|
|
# target: install-systemd - Install systemd timer and service files.
|
|
install-systemd:
|
|
install -d $(DEST_SYSTEMD)
|
|
install -m 0644 $(SRCS_SYSTEMD) $(DEST_SYSTEMD)
|
|
|
|
# target: uninstall - Uninstall ALL files from the install targets.
|
|
uninstall:
|
|
@for file in $(INSTALLED_FILES); do \
|
|
echo $(RM) $$file; \
|
|
$(RM) $$file; \
|
|
done
|