Commit Graph

168 Commits

Author SHA1 Message Date
Gerard Bosch
b4684d3cfb Fix README: Backup frequency (#68) 2022-02-08 13:01:32 +01:00
Erik Westrup
645df1a0d4 Move /sbin to /bin
As more users would have /bin than /sbin in their PATH
2022-02-07 18:22:36 +01:00
Erik Westrup
54e2d17e23 Modified: CHANGELOG.md Makefile 2022-02-06 15:28:56 +01:00
Erik Westrup
0fc7c29c2f Push image down 2022-02-06 15:26:43 +01:00
Erik Westrup
a57971e27e Add navigation tip 2022-02-06 15:25:45 +01:00
Erik Westrup
eb6e7b4a8d Begin structure README after system setup 2022-02-06 15:16:19 +01:00
Erik Westrup
c01bb5a00e Fix broken help target 2022-02-06 15:10:31 +01:00
Erik Westrup
8db3d27174 Rename top-level install targets
"make install" -> "make install-systemd"
so that I could now add a
""make install-cron"
target.

Soon there will be
"make install-macos"
"make install-windows"

Thus it does not make sense to have a general `make install` anymore.
2022-02-06 14:49:00 +01:00
Erik Westrup
1ee0e2c919 Fix cron with multiple profiles 2022-02-06 14:36:41 +01:00
Erik Westrup
21bb0535ee Note about make needing to be GNU make 2022-02-05 15:56:32 +01:00
Erik Westrup
0255ad03d8 Format comments 2022-02-05 15:52:36 +01:00
Erik Westrup
5942762514 Correct build source depdendency 2022-02-05 15:48:58 +01:00
Erik Westrup
6b315814d0 spell 2022-02-05 15:45:45 +01:00
Erik Westrup
dd092af6a1 Remove legacy .template 2022-02-05 15:43:57 +01:00
Erik Westrup
7f86dbd9f4 Consistent macro names in Makefile 2022-02-05 15:40:00 +01:00
Erik Westrup
494bcc29f0 s/SCRIPTS/SCRIPT/g 2022-02-05 15:40:00 +01:00
Erik Westrup
dc28ad2b52 Update README.md
Co-authored-by: Gerard Bosch <30733556+gerardbosch@users.noreply.github.com>
2022-02-05 15:28:14 +01:00
Erik Westrup
c43367fab3 Simpler sed expression 2022-02-05 15:27:43 +01:00
Erik Westrup
67cd6ee94b Add back dependency on builddir 2022-02-05 15:18:39 +01:00
Erik Westrup
a117c95508 Format Makefile 2022-02-05 15:13:01 +01:00
Erik Westrup
fc04da5a2d Fix comment 2022-02-05 15:04:44 +01:00
Erik Westrup
25666f17a0 Remove old out-commented solution 2022-02-05 15:02:53 +01:00
Erik Westrup
ccf39e822d Remove comment not relevant 2022-02-05 15:02:24 +01:00
Erik Westrup
1a890de7ac Remove target dependency that was not cleaned up before 2022-02-05 14:55:24 +01:00
Erik Westrup
4236c93b57 spell 2022-02-05 14:53:32 +01:00
Erik Westrup
861535a86e Check properly for GNU install 2022-02-05 14:48:38 +01:00
Erik Westrup
9760cd05ec Truly support custom PREFIX= install
* Before, doing `$ PREFIX=/usr/local make install` would install files to`/usr/local/usr/local..` which is wrong
* With this PR, files will be installed to the expected location e.g. `/usr/local/etc/restic`
* `Makefile` almost completely rewritten
   * As e.g. `default.env` would source `_global.env`, `default.env` must be edited to find the right location of `_global.env` depending on what `$PREFIX` was set to.
   * see documented build stages in the `Makefile` itself.
   *  Made sure that the rules are correct so that only modifed files are installed, not all at once unnecessarily like before.
* A sub-goal was that the [PKGBUILD](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=restic-systemd-automatic-backup#n20) for Arch should not need to do any custom install configuration, to keep everything easier to maintain. `$ make install` should work out of the box for Arch.
* Additionally added the `-b` flag to `install(1)` that makes a backup of existing `etc/restic/*` files before installing a newer version.

Fixes #49
2022-02-03 20:52:00 +01:00
Gerard Bosch
3852e305b6 Add resticw (restic wrapper) utility (#60)
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>
2022-02-03 20:40:45 +01:00
Erik Westrup
73bce43f7d s/TODO/*EDIT*/ to not confuse with development TODOs 2022-02-03 14:41:21 +01:00
Erik Westrup
7499dbefcd Modified: .github/workflows/linter.yml 2022-02-02 08:10:19 +01:00
Erik Westrup
10c46e8d54 Manually trigger linter 2022-02-02 07:57:02 +01:00
Erik Westrup
ce73193128 Trigger linter on all usr/local/sbin edits 2022-02-02 07:53:30 +01:00
Erik Westrup
90358c4f7a README: project scope 2022-02-01 19:51:35 +01:00
Erik Westrup
7f3647fb0c Rel should have been major as of breaking change v4.0.0 2022-02-01 19:41:02 +01:00
Erik Westrup
dd073dfc73 Fix arguments by using arrays to buildup 2022-02-01 19:24:38 +01:00
Erik Westrup
b23d552f0b Allow set but empty envvars v3.0.1 2022-02-01 18:31:27 +01:00
Erik Westrup
4142dbf20e Modified: CHANGELOG.md v3.0.0 2022-02-01 18:18:21 +01:00
Erik Westrup
629fd4c182 Align tag badge next to aur ver badge 2022-02-01 18:05:02 +01:00
Erik Westrup
7808dd6ecc Revert "Test that lint fails"
This reverts commit 082089a203.
2022-02-01 18:04:37 +01:00
Erik Westrup
082089a203 Test that lint fails 2022-02-01 18:03:11 +01:00
Erik Westrup
5e51341c51 Trigger linter on self-modify 2022-02-01 17:53:30 +01:00
Erik Westrup
130372e641 Restrict linting to bash 2022-02-01 17:52:39 +01:00
Erik Westrup
b3c64ca2ee Add lint badge 2022-02-01 17:37:23 +01:00
Erik Westrup
33a16ddb75 Modified: usr/local/sbin/restic_backup.sh 2022-02-01 17:20:30 +01:00
Erik Westrup
f1304f7db9 Modified: README.md 2022-02-01 17:20:00 +01:00
Erik Westrup
fad429fd34 Add shellcheck linter workflow
Fixes #57
2022-02-01 17:19:08 +01:00
Erik Westrup
9b7db6d999 Run shellcheck on all shellscripts 2022-02-01 17:15:47 +01:00
Erik Westrup
79d13a1e64 Prefix envvars with RESTIC_ for consistencty
Fix #63
2022-02-01 16:59:12 +01:00
Erik Westrup
4e8b8adff6 Rename backup_exclude to backup_exclude.txt
Fixes #64
2022-02-01 16:52:20 +01:00
Erik Westrup
687111fddf Assert that all envvars are set in scripts
Remind user to source profile before executing.

Fixes #62
2022-02-01 16:45:19 +01:00