cjones/restic-automatic-backup-scheduler
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename top-level install targets

Browse Source 
"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.
This commit is contained in:
Erik Westrup
2022-02-06 14:49:00 +01:00
parent 1ee0e2c919
commit 8db3d27174
2 changed files with 32 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
Makefile
View File

@@ -14,8 +14,10 @@
# copy them to a build directory and then modify.
#### Non-file targets #########################################################
.PHONY: all help clean uninstall \
install install-scripts install-conf install-systemd install-cron
.PHONY: help clean uninstall \
install-systemd install-cron \
install-targets-script install-targets-conf install-targets-systemd \
install-targets-cron
#### Macros ###################################################################
NOW := $(shell date +%Y-%m-%d_%H:%M:%S)
@@ -79,10 +81,8 @@ INSTALLED_FILES = $(DEST_TARGS_SCRIPT) $(DEST_TARGS_CONF) \
#### Targets ##################################################################
# target: all - Default target.
all: install
# target: help - Display all targets.
# target: help - Default target - displayes all targets.
# TODO sed is broken
help:
@egrep "#\starget:" [Mm]akefile | \
sed 's/\s-\s/\t\t\t/' | cut -d " " -f3- | sort -d
@@ -91,7 +91,7 @@ help:
clean:
$(RM) -r $(BUILD_DIR)
# target: uninstall - Uninstall ALL files from the install targets.
# target: uninstall - Uninstall ALL files from all install targets.
uninstall:
@for file in $(INSTALLED_FILES); do \
echo $(RM) $$file; \
@@ -100,21 +100,23 @@ uninstall:
# 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
# target: install - Install all files
install: install-scripts install-conf install-systemd
# $ PREFIX=/usr/local make install-systemd
# $ PREFIX=/tmp/test make install-systemd
# target: install-systemd - Install systemd setup.
install-systemd: install-targets-script install-targets-conf install-targets-systemd
# target: install-cron - Install cron setup.
install-cron: install-targets-cron
# Install targets. Prereq build sources as well,
# so that build dir is re-created if deleted.
# target: install-scripts - Install executables.
install-scripts: $(DEST_TARGS_SCRIPT) $(BUILD_SRCS_SCRIPT)
# target: install-conf - Install restic configuration files.
install-conf: $(DEST_TARGS_CONF) $(BUILD_SRCS_CONF)
# target: install-systemd - Install systemd timer and service files.
install-systemd: $(DEST_TARGS_SYSTEMD) $(BUILD_SRCS_SYSTEMD)
# target: install-cron - Install cronjob.
install-cron: $(DEST_TARGS_CRON) $(BUILD_SRCS_CRON)
# target: install-targets-script - Install executables.
install-targets-script: $(DEST_TARGS_SCRIPT) $(BUILD_SRCS_SCRIPT)
# target: install-targets-conf - Install restic configuration files.
install-targets-conf: $(DEST_TARGS_CONF) $(BUILD_SRCS_CONF)
# target: install-targets-systemd - Install systemd timer and service files.
install-targets-systemd: $(DEST_TARGS_SYSTEMD) $(BUILD_SRCS_SYSTEMD)
# target: install-targets-cron - Install cronjob.
install-targets-cron: $(DEST_TARGS_CRON) $(BUILD_SRCS_CRON)
# Copies sources to build directory & replace "$INSTALL_PREFIX".
$(BUILD_DIR)/% : %

18
README.md
View File

@@ -37,11 +37,15 @@ Nevertheless the project should work out of the box, be minimal but still open t
* (recommended) GNU `make` if you want an automated install
* Arch: part of the `base-devel` meta package, Debian/Ubuntu: part of the `build-essential` meta package, macOS: use the preinstalled or a more recent with Homebrew)
# TL;DR Setup
1. Create B2 credentials as instructed [below](#1-create-backblaze-b2-account)
1. Install config and scripts:
```console
$ sudo make install
$ sudo make install-systemd
```
☝ **Note**: `sudo` is required here, as some files are installed into system directories (`/etc/`
and `/usr/sbin`). Have a look to the `Makefile` to know more.
@@ -88,10 +92,10 @@ Tip: The steps in this section will instruct you to copy files from this repo to
```console
$ git clone https://github.com/erikw/restic-systemd-automatic-backup.git && cd $(basename "$_" .git)
$ sudo make install
$ sudo make install-systemd
````
If you want to install everything manually, we will install files to `/etc`, `/sbin`, and not use the `$make install` command, then you need to clean up a placeholder `$INSTALL_PREFIX` in the souce files first by running:
If you want to install everything manually, we will install files to `/etc`, `/sbin`, and not use the `$make install-systemd` command, then you need to clean up a placeholder `$INSTALL_PREFIX` in the souce files first by running:
```console
$ find etc sbin -type f -exec sed -i.bak -e 's|$INSTALL_PREFIX||g' {} \; -exec rm {}.bak \;
```
@@ -100,7 +104,7 @@ and you should now see that all files have been changed like e.g.
-export RESTIC_PASSWORD_FILE="$INSTALL_PREFIX/etc/restic/pw.txt"
+export RESTIC_PASSWORD_FILE="/etc/restic/pw.txt"
```
This prefix is there so that `make` users can set a different `$PREFIX` when installing like `PREFIX=/usr/local make install`. So if we don't use the makefile, we need to remove this prefix with the command above just.
This prefix is there so that `make` users can set a different `$PREFIX` when installing like `PREFIX=/usr/local make install-systemd`. So if we don't use the makefile, we need to remove this prefix with the command above just.
Arch Linux users can install the aur package [restic-systemd-automatic-backup](https://aur.archlinux.org/packages/restic-systemd-automatic-backup/) e.g.:
@@ -256,11 +260,11 @@ straightforward (it needs to run with sudo to read environment). Just run:
If you want to run an all-classic cron job instead, do like this:
* `etc/cron.d/restic`: Depending on your system's cron, put this in `/etc/cron.d/` or similar, or copy the contents to $(sudo crontab -e). The format of this file is tested under FreeBSD, and might need adaptions depending on your cron.
* You can use `$ make install-cron` to copy it over to `/etc/cron.d`.
* `sbin/cron_mail`: A wrapper for running cron jobs, that sends output of the job as an email using the mail(1) command.
# Uninstall
There is a make target to remove all files (scripts and configs) that were installed by `sudo make install`. Just run:
There is a make target to remove all files (scripts and configs) that were installed by `sudo make install-*`. Just run:
```console
$ sudo make uninstall
@@ -273,7 +277,7 @@ A list of variations of this setup:
# Development
* To not mess up your real installation when changing the `Makefile` simply install to a `$PREFIX` like
```console
$ PREFIX=/tmp/restic-test make install
$ PREFIX=/tmp/restic-test make install-systemd
```
* **Updating the `resticw` parser:** If you ever update the usage `DOC`, you will need to refresh the auto-generated parser:
```console