Modified: CHANGELOG.md

How to disable old launchagent
2022-02-13 19:20:15 +01:00 · 2022-02-13 19:20:02 +01:00 · 2022-02-13 19:19:00 +01:00 · 2022-02-13 19:18:37 +01:00 · 2022-02-13 19:15:55 +01:00 · 2022-02-13 18:47:31 +01:00
17 changed files with 248 additions and 60 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

 ## [Unreleased]

+## [7.1.0] - 2022-02-13
+### Changed
+- Minimize base install. The following features are now opt-in: nm-unmetered detection, cron_mail, systemd-email.
+
+## [7.0.0] - 2022-02-13
+### Changed
+- Renamed project from `restic-systemd-automatic-backup` to `restic-automatic-backup-scheduler` to fit all now supported setups.
+
+## [6.0.0] - 2022-02-12
+### Added
+- Windows support with native ScheduledTask! New target `$ make install-schedtask` for Windows users.
+
+## [5.3.1] - 2022-02-12
+### Fixed
+- Launchagentdir make macro
+
+## [5.3.0] - 2022-02-12
+### Added
+- Allow custom launchagent dir, used by Homebrew.
+
+## [5.2.1] - 2022-02-11
+### Added
+- Homebrew Formula at [erikw/homebrew-tap](https://github.com/erikw/homebrew-tap). You can now install with `$ brew install erikw/tap/restic-automatic-backup-scheduler`!
+
+### Fixed
+- Use default profile in LaunchAgent.
+
 ## [5.2.0] - 2022-02-11
 ### Added
 - Make option to override destination dir for configuration files. Needed for Homebrew.
@@ -25,7 +52,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `$ make install-cron` for installing the cron-job.

 ### Changed
- **BREAKING CHANGE** moved systemd installation with makefile from `/etc/systemd/system` to `/usr/lib/systemd/system` as this is what packages should do. This is to be able to simplify the arch [PKGBUILD](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=restic-systemd-automatic-backup) so that it does not need to do anything else than `make install`.
+- **BREAKING CHANGE** moved systemd installation with makefile from `/etc/systemd/system` to `/usr/lib/systemd/system` as this is what packages should do. This is to be able to simplify the arch [PKGBUILD](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=restic-automatic-backup-scheduler) so that it does not need to do anything else than `make install`.
   - If you upgrade form an existing install, you should disable and then re-enable the timer, so that the symlink is pointing to the new location of the timer.
   ```console
   # systemctl disable restic-backup@<profile>.timer
@@ -69,7 +96,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

 ## [2.0.0] - 2022-02-01
 ### Changed
- **BREAKING CHANGE** [#45](https://github.com/erikw/restic-systemd-automatic-backup/pull/45): multiple backup profiles are now supported. Please backup your configuration before upgrading. The setup of configuration files are now laied out differently. See the [README.md](README.md) TL;DR setup section.
+- **BREAKING CHANGE** [#45](https://github.com/erikw/restic-automatic-backup-scheduler/pull/45): multiple backup profiles are now supported. Please backup your configuration before upgrading. The setup of configuration files are now laied out differently. See the [README.md](README.md) TL;DR setup section.
  - `restic_backup.sh` has had variables extracted to profiles instead, to allow for configuration of different backups on the same system.
  - `b2_env.sh` is split to two files `_global.env` and `default.env` (the default profile). `_global.env` will have B2 accountID and accountKey and `default.env` has backup paths, and retention.
  - `b2_pw.sh` renamed to pw.txt
@@ -80,7 +107,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

 ## [1.0.1] - 2021-12-03
 ### Fixed
- $(make install) now works for the *.template files ([#40](https://github.com/erikw/restic-systemd-automatic-backup/issues/40))
+- $(make install) now works for the *.template files ([#40](https://github.com/erikw/restic-automatic-backup-scheduler/issues/40))

 ## [1.0.0] - 2021-12-02
 It's time to call this a proper major version!
--- a/3
+++ b/3
@@ -1,5 +1,4 @@
-restic-systemd-automatic-backup -  My restic backup solution using Backblaze B2 storage, systemd timers (or cron) and email notifications on failure.
-
+restic-automatic-backup-scheduler - Automatic restic backup using Backblaze B2 storage, Linux systemd timers, macOS LaunchAgent, Windows ScheduledTask or simply cron

 Copyright (c) 2022, Erik Westrup + see commit log for auhtors
 All rights reserved.
--- a/Library/LaunchAgents/com.github.erikw.restic-automatic-backup-scheduler.plist
+++ b/Library/LaunchAgents/com.github.erikw.restic-automatic-backup-scheduler.plist
@@ -6,13 +6,13 @@
 <plist version="1.0">
 	<dict>
 		<key>Label</key>
-		<string>com.github.erikw.restic-automatic-backup</string>
+		<string>com.github.erikw.restic-automatic-backup-scheduler</string>
 		<key>ProgramArguments</key>
 		<!-- exec in subshell to 1) source *.env.sh 2) expand $HOME to logpath (ref. https://apple.stackexchange.com/a/365880/197493) -->
 		<array>
 			<string>/bin/bash</string>
 			<string>-c</string>
-			<string>source /usr/local/etc/restic/erikw.env.sh &amp;&amp; /usr/local/bin/restic_backup.sh >>$HOME/$LOG_OUT 2>>$HOME/$LOG_ERR</string>
+			<string>source /usr/local/etc/restic/default.env.sh &amp;&amp; /usr/local/bin/restic_backup.sh >>$HOME/$LOG_OUT 2>>$HOME/$LOG_ERR</string>
 		</array>
 		<key>EnvironmentVariables</key>
 		<dict>
--- a/56
+++ b/56
@@ -18,7 +18,8 @@
 .PHONY: help clean uninstall \
 	install-systemd install-cron \
 	install-targets-script install-targets-conf install-targets-systemd \
-	install-targets-cron \
+	install-targets-cron install-targets-launchagent \
+	install-targets-schedtask uninstall-targets-schedtask \
 	activate-launchagent deactivate-launchagent

 #### Macros ###################################################################
@@ -33,6 +34,15 @@ else
    BAK_SUFFIX = -B .$(NOW).bak
 endif

+
+# Source: https://stackoverflow.com/a/14777895/265508
+ifeq ($(OS),Windows_NT)
+    CUR_OS := Windows
+else
+    CUR_OS := $(shell uname)
+endif
+
+
 # Create parent directories of a file, if not existing.
 # Reference: https://stackoverflow.com/a/25574592/265508
 MKDIR_PARENTS=sh -c '\
@@ -42,7 +52,7 @@ MKDIR_PARENTS=sh -c '\

 # LaunchAgent names.
 UID					:= $(shell id -u)
-LAUNCHAGENT			= com.github.erikw.restic-automatic-backup
+LAUNCHAGENT			= com.github.erikw.restic-automatic-backup-scheduler
 LAUNCHAGENT_TARGET	= gui/$(UID)/$(LAUNCHAGENT)

 # What to substitute $INSTALL_PREFIX in sources to.
@@ -53,28 +63,45 @@ INSTALL_PREFIX := $(PREFIX)
 # Where to install persistent configuration files. Used by Homebrew.
 SYSCONFDIR := $(PREFIX)

+# Where to install LaunchAgent. Used by Homebrew.
+LAUNCHAGENTDIR := $(HOME)
+
+# ScheduledTask powershell scripts.
+SCHEDTASK_INSTALL	= install.ps1
+SCHEDTASK_UNINSTALL = uninstall.ps1
+
 # Source directories.
 DIR_SCRIPT		= bin
 DIR_CONF		= etc/restic
 DIR_SYSTEMD		= usr/lib/systemd/system
 DIR_CRON		= etc/cron.d
 DIR_LAUNCHAGENT	= Library/LaunchAgents
+DIR_SCHEDTASK	= ScheduledTask

 # Source files.
-SRCS_SCRIPT		= $(filter-out %cron_mail, $(wildcard $(DIR_SCRIPT)/*))
+SRCS_SCRIPT		= $(filter-out \
+						%cron_mail \
+						%systemd-email \
+						%nm-unmetered-connection.sh \
+					, $(wildcard $(DIR_SCRIPT)/*))
 SRCS_CONF		= $(wildcard $(DIR_CONF)/*)
-SRCS_SYSTEMD	= $(wildcard $(DIR_SYSTEMD)/*)
+SRCS_SYSTEMD	= $(filter-out \
+						%status-email-user@.service \
+						%nm-unmetered-connection.service \
+					, $(wildcard $(DIR_SYSTEMD)/*))
 SRCS_CRON		= $(wildcard $(DIR_CRON)/*)
 SRCS_LAUNCHAGENT= $(wildcard $(DIR_LAUNCHAGENT)/*)
+SRCS_SCHEDTASK	= $(wildcard $(DIR_SCHEDTASK)/*)

 # Local build directory. Sources will be copied here,
 # modified and then installed from this directory.
-BUILD_DIR				:= build
+BUILD_DIR				= build
 BUILD_DIR_SCRIPT		= $(BUILD_DIR)/$(DIR_SCRIPT)
 BUILD_DIR_CONF			= $(BUILD_DIR)/$(DIR_CONF)
 BUILD_DIR_SYSTEMD		= $(BUILD_DIR)/$(DIR_SYSTEMD)
 BUILD_DIR_CRON			= $(BUILD_DIR)/$(DIR_CRON)
 BUILD_DIR_LAUNCHAGENT	= $(BUILD_DIR)/$(DIR_LAUNCHAGENT)
+BUILD_DIR_SCHEDTASK		= $(BUILD_DIR)/$(DIR_SCHEDTASK)

 # Sources copied to build directory.
 BUILD_SRCS_SCRIPT		= $(addprefix $(BUILD_DIR)/, $(SRCS_SCRIPT))
@@ -82,13 +109,14 @@ BUILD_SRCS_CONF			= $(addprefix $(BUILD_DIR)/, $(SRCS_CONF))
 BUILD_SRCS_SYSTEMD		= $(addprefix $(BUILD_DIR)/, $(SRCS_SYSTEMD))
 BUILD_SRCS_CRON			= $(addprefix $(BUILD_DIR)/, $(SRCS_CRON))
 BUILD_SRCS_LAUNCHAGENT	= $(addprefix $(BUILD_DIR)/, $(SRCS_LAUNCHAGENT))
+BUILD_SRCS_SCHEDTASK	= $(addprefix $(BUILD_DIR)/, $(SRCS_SCHEDTASK))

 # Destination directories
 DEST_DIR_SCRIPT		= $(PREFIX)/$(DIR_SCRIPT)
 DEST_DIR_CONF		= $(SYSCONFDIR)/$(DIR_CONF)
 DEST_DIR_SYSTEMD	= $(PREFIX)/$(DIR_SYSTEMD)
 DEST_DIR_CRON		= $(PREFIX)/$(DIR_CRON)
-DEST_DIR_LAUNCHAGENT= $(HOME)/$(DIR_LAUNCHAGENT)
+DEST_DIR_LAUNCHAGENT= $(LAUNCHAGENTDIR)/$(DIR_LAUNCHAGENT)
 DEST_DIR_MAC_LOG	= $(HOME)/Library/Logs/restic

 # Destination file targets.
@@ -96,7 +124,7 @@ DEST_TARGS_SCRIPT		= $(addprefix $(PREFIX)/, $(SRCS_SCRIPT))
 DEST_TARGS_CONF			= $(addprefix $(SYSCONFDIR)/, $(SRCS_CONF))
 DEST_TARGS_SYSTEMD		= $(addprefix $(PREFIX)/, $(SRCS_SYSTEMD))
 DEST_TARGS_CRON			= $(addprefix $(PREFIX)/, $(SRCS_CRON))
-DEST_TARGS_LAUNCHAGENT	= $(addprefix $(HOME)/, $(SRCS_LAUNCHAGENT))
+DEST_TARGS_LAUNCHAGENT	= $(addprefix $(LAUNCHAGENTDIR)/, $(SRCS_LAUNCHAGENT))

 INSTALLED_FILES = $(DEST_TARGS_SCRIPT) $(DEST_TARGS_CONF) \
 				  $(DEST_TARGS_SYSTEMD) $(DEST_TARGS_CRON) \
@@ -113,7 +141,7 @@ clean:
 	$(RM) -r $(BUILD_DIR)

 # target: uninstall - Uninstall ALL installed (including config) files.
-uninstall:
+uninstall: uninstall-schedtask
 	@for file in $(INSTALLED_FILES); do \
 			echo $(RM) $$file; \
 			$(RM) $$file; \
@@ -134,6 +162,13 @@ install-cron: install-targets-script install-targets-conf install-targets-cron
 install-launchagent: install-targets-script install-targets-conf \
 						install-targets-launchagent

+# target: install-schedtask - Install Windows ScheduledTasks
+install-schedtask: install-targets-script install-targets-conf \
+						install-targets-schedtask
+
+# target: uninstall-schedtask - Uninstall Windows ScheduledTasks
+uninstall-schedtask: uninstall-targets-schedtask
+
 # Install targets. Prereq build sources as well,
 # so that build dir is re-created if deleted.
 install-targets-script: $(DEST_TARGS_SCRIPT) $(BUILD_SRCS_SCRIPT)
@@ -142,6 +177,11 @@ install-targets-systemd: $(DEST_TARGS_SYSTEMD) $(BUILD_SRCS_SYSTEMD)
 install-targets-cron: $(DEST_TARGS_CRON) $(BUILD_SRCS_CRON)
 install-targets-launchagent: $(DEST_TARGS_LAUNCHAGENT) \
 	$(BUILD_SRCS_LAUNCHAGENT) $(DEST_DIR_MAC_LOG)
+install-targets-schedtask: $(BUILD_DIR_SCHEDTASK)/$(SCHEDTASK_INSTALL)
+	test $(CUR_OS) != Windows || ./$<
+
+uninstall-targets-schedtask: $(BUILD_DIR_SCHEDTASK)/$(SCHEDTASK_UNINSTALL)
+	test $(CUR_OS) != Windows || ./$<

 # Copies sources to build directory & replace "$INSTALL_PREFIX".
 $(BUILD_DIR)/% : %
--- a/README.md
+++ b/README.md
@@ -1,27 +1,30 @@
 # Automatic restic backups using systemd services and timers
-[![GitHub Stars](https://img.shields.io/github/stars/erikw/restic-systemd-automatic-backup?style=social)](#)
-[![GitHub Forks](https://img.shields.io/github/forks/erikw/restic-systemd-automatic-backup?style=social)](#)
+*formerly named restic-systemd-automatic-backup*
+
+[![GitHub Stars](https://img.shields.io/github/stars/erikw/restic-automatic-backup-scheduler?style=social)](#)
+[![GitHub Forks](https://img.shields.io/github/forks/erikw/restic-automatic-backup-scheduler?style=social)](#)
 <br>
-[![Lint Code Base](https://github.com/erikw/restic-systemd-automatic-backup/actions/workflows/linter.yml/badge.svg)](https://github.com/erikw/restic-systemd-automatic-backup/actions/workflows/linter.yml)
-[![Latest tag](https://img.shields.io/github/v/tag/erikw/restic-systemd-automatic-backup)](https://github.com/erikw/restic-systemd-automatic-backup/tags)
-[![AUR version](https://img.shields.io/aur/version/restic-systemd-automatic-backup)](https://aur.archlinux.org/packages/restic-systemd-automatic-backup/)
-[![AUR maintainer](https://img.shields.io/aur/maintainer/restic-systemd-automatic-backup?label=AUR%20maintainer)](https://aur.archlinux.org/packages/restic-systemd-automatic-backup/)
-[![Open issues](https://img.shields.io/github/issues/erikw/restic-systemd-automatic-backup)](https://github.com/erikw/restic-systemd-automatic-backup/issues)
-[![Closed issues](https://img.shields.io/github/issues-closed/erikw/restic-systemd-automatic-backup?color=success)](https://github.com/erikw/restic-systemd-automatic-backup/issues?q=is%3Aissue+is%3Aclosed)
-[![Closed PRs](https://img.shields.io/github/issues-pr-closed/erikw/restic-systemd-automatic-backup?color=success)](https://github.com/erikw/restic-systemd-automatic-backup/pulls?q=is%3Apr+is%3Aclosed)
+[![Lint Code Base](https://github.com/erikw/restic-automatic-backup-scheduler/actions/workflows/linter.yml/badge.svg)](https://github.com/erikw/restic-automatic-backup-scheduler/actions/workflows/linter.yml)
+[![Latest tag](https://img.shields.io/github/v/tag/erikw/restic-automatic-backup-scheduler)](https://github.com/erikw/restic-automatic-backup-scheduler/tags)
+[![AUR version](https://img.shields.io/aur/version/restic-automatic-backup-scheduler)](https://aur.archlinux.org/packages/restic-automatic-backup-scheduler/)
+[![AUR maintainer](https://img.shields.io/aur/maintainer/restic-automatic-backup-scheduler?label=AUR%20maintainer)](https://aur.archlinux.org/packages/restic-automatic-backup-scheduler/)
+[![Homebrew Formula](https://img.shields.io/badge/homebrew-erikw%2Ftap-orange)](https://github.com/erikw/homebrew-tap)
+[![Open issues](https://img.shields.io/github/issues/erikw/restic-automatic-backup-scheduler)](https://github.com/erikw/restic-automatic-backup-scheduler/issues)
+[![Closed issues](https://img.shields.io/github/issues-closed/erikw/restic-automatic-backup-scheduler?color=success)](https://github.com/erikw/restic-automatic-backup-scheduler/issues?q=is%3Aissue+is%3Aclosed)
+[![Closed PRs](https://img.shields.io/github/issues-pr-closed/erikw/restic-automatic-backup-scheduler?color=success)](https://github.com/erikw/restic-automatic-backup-scheduler/pulls?q=is%3Apr+is%3Aclosed)
 [![License](https://img.shields.io/badge/license-BSD--3-blue)](LICENSE)
-[![OSS Lifecycle](https://img.shields.io/osslifecycle/erikw/restic-systemd-automatic-backup)](https://github.com/Netflix/osstracker)
+[![OSS Lifecycle](https://img.shields.io/osslifecycle/erikw/restic-automatic-backup-scheduler)](https://github.com/Netflix/osstracker)
 <br>

-[![Contributors](https://img.shields.io/github/contributors/erikw/restic-systemd-automatic-backup)](https://github.com/erikw/restic-systemd-automatic-backup/graphs/contributors) including these top contributors:
-<a href = "https://github.com/erikw/restic-systemd-automatic-backup/graphs/contributors">
-<img src = "https://contrib.rocks/image?repo=erikw/restic-systemd-automatic-backup&max=24"/>
+[![Contributors](https://img.shields.io/github/contributors/erikw/restic-automatic-backup-scheduler)](https://github.com/erikw/restic-automatic-backup-scheduler/graphs/contributors) including these top contributors:
+<a href = "https://github.com/erikw/restic-automatic-backup-scheduler/graphs/contributors">
+<img src = "https://contrib.rocks/image?repo=erikw/restic-automatic-backup-scheduler&max=24"/>
 </a>

 # Intro
 [restic](https://restic.net/) is a command-line tool for making backups, the right way. Check the official website for a feature explanation. As a storage backend, I recommend [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html) as restic works well with it, and it is (at the time of writing) very affordable for the hobbyist hacker! (anecdotal: I pay for my full-systems backups each month typically < 1 USD).

-Unfortunately restic does not come pre-configured with a way to run automated backups, say every day. However it's possible to set this up yourself using systemd/cron and some wrappers. This example also features email notifications when a backup fails to complete.
+Unfortunately restic does not come pre-configured with a way to run automated backups, say every day. However it's possible to set this up yourself using built-in tools in your OS and some wrappers. For Linux with systemd, it's convenient to use systemd timers. For macOS systems, we can use built-in LaunchAgents. For Windows we can use ScheduledTasks. Any OS having something cron-like will also work!

 Here follows a step-by step tutorial on how to set it up, with my sample script and configurations that you can modify to suit your needs.

@@ -49,6 +52,7 @@ Tip: use the Section icon in the top left of this document to navigate the secti
 Depending on your system, the setup will look different. Choose one of
 * <img height="16" width="16" src="https://unpkg.com/simple-icons@v6/icons/linux.svg" /> [Linux + Systemd](#setup-linux-systemd)
 * <img height="16" width="16" src="https://unpkg.com/simple-icons@v6/icons/apple.svg" /> [macOS + LaunchAgent](#setup-macos-launchagent)
+* <img height="16" width="16" src="https://unpkg.com/simple-icons@v6/icons/windows.svg" /> [Windows + ScheduledTask](#setup-windows-scheduledtask)
 * <img height="16" width="16" src="https://unpkg.com/simple-icons@v6/icons/clockify.svg" /> [Cron](#setup-cron) - for any system having a cron daemon. Tested on FreeBSD and macOS.

 ## Setup Linux Systemd
@@ -100,7 +104,7 @@ This is a more detailed explanation than the TL;DR section that will give you mo
 Tip: The steps in this section will instruct you to copy files from this repo to system directories. If you don't want to do this manually, you can use the Makefile:

 ```console
-$ git clone https://github.com/erikw/restic-systemd-automatic-backup.git && cd $(basename "$_" .git)
+$ git clone https://github.com/erikw/restic-automatic-backup-scheduler.git && cd $(basename "$_" .git)
 $ sudo make install-systemd
 ````

@@ -116,9 +120,9 @@ and you should now see that all files have been changed like e.g.
 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.:
+Arch Linux users can install the aur package [restic-automatic-backup-scheduler](https://aur.archlinux.org/packages/restic-automatic-backup-scheduler/) e.g. with `yay(1)`:
 ```console
-$ yaourt -S restic-systemd-automatic-backup
+$ yay -S restic-automatic-backup-scheduler
 ````

 #### 1. Create Backblaze B2 Account, Bucket and keys
@@ -233,7 +237,10 @@ Put this file in `/bin`:
 Put this files in `/etc/systemd/system/`:
 * `status-email-user@.service`: A service that can notify you via email when a systemd service fails. Edit the target email address in this file.

-As you maybe noticed already before, `restic-backup.service` is configured to start `status-email-user.service` on failure.
+Now edit `restic-backup.service` and `status-email-user.service` to call this service failure.
+```
+OnFailure=status-email-user@%n.service
+```


 #### 9. Optional: automated backup checks
@@ -245,7 +252,23 @@ There is companion scripts, service and timer (`*check*`) to restic-backup.sh th
 $ sudo systemctl enable --now restic-check@default.timer
 ````

-#### 10. Optional: 🏃 Restic wrapper
+#### 10. Optional: No backup on metered connections
+For a laptop, it can make sense to not do heavy backups when your on a metered connection like a shared connection from you mobile phone. To solve this we can set up a systemd service that is in success state only when a connection is unmetered. Then we can tell our backup service to depend on this service simply! When the unmetered service detects an unmetered connection it will go to failed state. Then our backup service will not run as it requires this other service to be in success state.
+
+Put this file in `/bin`:
+* `nm-unmetered-connection.sh`: Detects metered connections and returns will error code if one is detected. This scripts requires the Gnome [NetworkManager](https://wiki.gnome.org/Projects/NetworkManager) to be installed. Modify this script if your system has a different network manager.
+
+Put this files in `/etc/systemd/system/`:
+* `nm-unmetered-connection.service`: A service that is in success state if the connection is unmetered only.
+
+Now edit `restic-backup.service` and `status-email-user.service` to require the new service to be in success state:
+```
+Requires=nm-unmetered-connection.service
+```
+
+
+
+#### 11. Optional: 🏃 Restic wrapper
 For convenience there's a `restic` wrapper script that makes loading profiles and **running restic**
 straightforward (it needs to run with sudo to read environment). Just run:

@@ -262,9 +285,28 @@ straightforward (it needs to run with sudo to read environment). Just run:
 | `resticw mount /mnt/restic`                       | Mount your remote repository                                      |

 ## Setup macOS LaunchAgent
-LaunchAgent is the modern service scheduler in in macOS that uses [Launchd](https://www.launchd.info/).
 [Launchd](https://www.launchd.info/) is the modern built-in service scheduler in macOS. It has support for running services as root (Daemon) or as a normal user (Agent). Here we set up an LauchAgent to be run as your normal user for starting regular backups.

+### Homebrew
+With Homebrew you can easily install this project from the [erikw/homebrew-tap](https://github.com/erikw/homebrew-tap):
+```console
+$ brew install erikw/tap/restic-automatic-backup-scheduler
+```
+
+Then control the service with homebrew:
+```console
+$ brew services start restic-automatic-backup-scheduler
+$ brew services restart restic-automatic-backup-scheduler
+$ brew services stop restic-automatic-backup-scheduler
+```
+
+If `services start` fails, it might be due to previous version installed. In that case remove the existing version and try again:
+```console
+$ launchctl bootout gui/$UID/com.github.erikw.restic-automatic-backup-scheduler
+$ brew services start restic-automatic-backup-scheduler
+```
+
+### Manual
 1. In general, follow the same setup as in (#setup-linux-systemd) except for:
  * use `make install-launchagent` instead of `make install-systemd`
  * install everything to `/usr/local` and run restic as your own user, not root
@@ -274,24 +316,68 @@ LaunchAgent is the modern service scheduler in in macOS that uses [Launchd](http
 	```
 1. After installation with `make` , edit the installed LaunchAgent if you want to change the default schedule or profile used:
 	```console
-	$ vim ~/Library/LaunchAgents/com.github.erikw.restic-automatic-backup.plist 
+	$ vim ~/Library/LaunchAgents/com.github.erikw.restic-automatic-backup.plist
 	```
 1. Now install, enable and start the first run!
 	```console
-	$ launchctl bootstrap gui/$UID ~/Library/LaunchAgents/com.github.erikw.restic-automatic-backup.plist
-	$ launchctl enable gui/$UID/com.github.erikw.restic-automatic-backup
-	$ launchctl kickstart -p gui/$UID/com.github.erikw.restic-automatic-backup
+	$ launchctl bootstrap gui/$UID ~/Library/LaunchAgents/com.github.erikw.restic-automatic-backup-scheduler.plist
+	$ launchctl enable gui/$UID/com.github.erikw.restic-automatic-backup-scheduler
+	$ launchctl kickstart -p gui/$UID/com.github.erikw.restic-automatic-backup-scheduler
 	```
 	As a convenience, a shortcut for the above commands are `$ make activate-launchagent`.

 Use the `disable` command to temporarily pause the agent, or `bootout` to uninstall it.
 ```
-$ launchctl disable gui/$UID/com.github.erikw.restic-automatic-backup
-$ launchctl bootout gui/$UID/com.github.erikw.restic-automatic-backup
+$ launchctl disable gui/$UID/com.github.erikw.restic-automatic-backup-scheduler
+$ launchctl bootout gui/$UID/com.github.erikw.restic-automatic-backup-scheduler
 ```

 If you updated the `.plist` file, you need to issue the `bootout` followed by `bootrstrap` and `enable` sub-commands of `launchctl`. This will guarantee that the file is properly reloaded.

+
+## Setup Windows ScheduledTask
+Windows comes with a built-in task scheduler called [ScheduledTask](https://docs.microsoft.com/en-us/powershell/module/scheduledtasks/new-scheduledtask?view=windowsserver2022-ps). The frontend app is "Task scheduler" (`taskschd.msc`) and we can use PowerShell commands to install a new scheduled task.
+
+This is one of may ways you can get restic and this backup script working on Windows:
+1. Install [scoop](https://scoop.sh/)
+1. Install dependencies from a PowerShell with administrator privileges:
+   ```console
+	powershell> scoop install restic make git
+   ```
+1. In a non-privileged PowerShell, start git-bash and clone this repo
+   ```console
+	powershell> git-bash
+	git-bash$ mkdir ~/src && cd ~/src/
+    git-bash$ git clone https://github.com/erikw/restic-automatic-backup-scheduler.git && cd $(basename "$_" .git)
+   ```
+1. Install scripts, conf and the ScheduledTask
+   ```console
+    git-bash$ make install-schedtask
+   ```
+1. Edit configs and initialize repo according to *TL;DR* section above
+   ```console
+    git-bash$ vim /etc/restic/*
+    git-bash$ source /etc/restic/default.env.sh
+    git-bash$ restic init
+    git-bash$ restic_backup.sh
+   ```
+   Note that you should use cygwin/git-bash paths e.g. in `default.env.sh` you can have
+   ```bash
+	export RESTIC_BACKUP_PATHS='/c/Users/<username>/My Documents'
+   ```
+1. Inspect the installed tasks and make a test run
+   1. Open the app "Task Scheduler" (`taskschd.msc`)
+   1. Go to the local "Task Scheduler Library"
+   1. Right click on one of the newly installed tasks e.g. `restic_backup` and click "run".
+      - If the tasks are not there, maybe you opended it up before `make install-schedtask`: just close and start it again to refresh.
+   1. Now a git-bash window should open running `restic_backup.sh`, and the next time the configured schedule hits!
+1. With `taskschd.msc` you can easily start, stop, delete and configure the scheduled tasks to your liking.
+
+
+After installing, you can control your backups through `tasksched.msc`:
+<a href="img/tasksched.png" title="Windows Task Scheduler"><img src="img/tasksched.png" width="512" alt="Windows Task Schedulder"></a>
+
+
 ## Setup Cron
 If you want to run an all-classic cron job instead, do like this:

@@ -310,7 +396,7 @@ $ sudo make uninstall

 # Variations
 A list of variations of this setup:
-* Using `--files-from` [#44](https://github.com/erikw/restic-systemd-automatic-backup/issues/44)
+* Using `--files-from` [#44](https://github.com/erikw/restic-automatic-backup-scheduler/issues/44)

 # Development
 * To not mess up your real installation when changing the `Makefile` simply install to a `$PREFIX` like
@@ -331,4 +417,5 @@ To make a new release:
   $ git tag vX.Y.Z
   $ git push && git push --tags
   ```
-1. Test and update the AUR [PKGBUILD](https://aur.archlinux.org/packages/restic-systemd-automatic-backup/) if needed.
+1. Update version in the AUR [PKGBUILD](https://aur.archlinux.org/packages/restic-automatic-backup-scheduler/).
+1. Update version in the Homebrew [Formula](https://github.com/erikw/homebrew-tap/blob/main/Formula/restic-automatic-backup-scheduler.rb).
--- a/ScheduledTask/install.ps1
+++ b/ScheduledTask/install.ps1
@@ -0,0 +1,19 @@
+#!/usr/bin/env pwsh
+# Install restic scheduled tasks.
+# Test run the installed actions by
+#   1. open the app "Task Scheduler" (taskschd.msc)
+#   2. go to the local "Task Scheduler Library"
+#   3. right click on the new tasks  and click "run".
+# Reference: https://blogs.technet.microsoft.com/heyscriptingguy/2015/01/13/use-powershell-to-create-scheduled-tasks/
+# Reference: https://www.davidjnice.com/cygwin_scheduled_tasks.html
+
+
+# Install restic_backup.sh
+$action = New-ScheduledTaskAction -Execute "$(scoop prefix git)\git-bash.exe" -Argument '-l -c "source $INSTALL_PREFIX/etc/restic/default.env.sh && $INSTALL_PREFIX/bin/restic_backup.sh"'
+$trigger =  New-ScheduledTaskTrigger -Daily -At 7pm
+Register-ScheduledTask -Action $action -Trigger $trigger -TaskName "restic_backup" -Description "Daily backup to B2 with restic."
+
+# Install restic_check.sh
+$action = New-ScheduledTaskAction -Execute "$(scoop prefix git)\git-bash.exe" -Argument '-l -c "source $INSTALL_PREFIX/etc/restic/default.env.sh && /INSTALL_PREFIX/bin/restic_check.sh"'
+$trigger =  New-ScheduledTaskTrigger  -Weekly -WeeksInterval 4 -DaysOfWeek Sunday -At 8pm -RandomDelay 128
+Register-ScheduledTask -Action $action -Trigger $trigger -TaskName "restic_check" -Description "Check B2 backups with restic."
--- a/ScheduledTask/uninstall.ps1
+++ b/ScheduledTask/uninstall.ps1
@@ -0,0 +1,5 @@
+#!/usr/bin/env pwsh
+# Uninstall restic scheduled tasks.
+
+Unregister-ScheduledTask -TaskName "restic_backup" -Confirm:$false
+Unregister-ScheduledTask -TaskName "restic_check" -Confirm:$false
--- a/bin/cron_mail
+++ b/bin/cron_mail
--- a/bin/nm-unmetered-connection.sh
+++ b/bin/nm-unmetered-connection.sh
@@ -1,19 +1,19 @@
-#!/bin/bash
+#!/usr/bin/env bash
+# Requires Gnome NetworkManager

 systemctl is-active dbus.service >/dev/null 2>&1 || exit 0
 systemctl is-active NetworkManager.service >/dev/null 2>&1 || exit 0

 metered_status=$(dbus-send --system --print-reply=literal \
-       	--system --dest=org.freedesktop.NetworkManager \
-	      /org/freedesktop/NetworkManager \
-	      org.freedesktop.DBus.Properties.Get \
-	      string:org.freedesktop.NetworkManager string:Metered \
-	      | grep -o ".$")
+		--system --dest=org.freedesktop.NetworkManager \
+		/org/freedesktop/NetworkManager \
+		org.freedesktop.DBus.Properties.Get \
+		string:org.freedesktop.NetworkManager string:Metered \
+		| grep -o ".$")

 if [[ $metered_status =~ (1|3) ]]; then
  echo Current connection is metered
  exit 1
-else 
+else
  exit 0
 fi
-
--- a/bin/restic_backup.sh
+++ b/bin/restic_backup.sh
@@ -57,6 +57,10 @@ for backup_path in "${backup_paths[@]}"; do
 	fi
 done

+# --one-file-system is not supportd on Windows (=msys).
+FS_ARG=
+test "$OSTYPE" = msys || FS_ARG=--one-file-system
+
 # NOTE start all commands in background and wait for them to finish.
 # Reason: bash ignores any signals while child process is executing and thus the trap exit hook is not triggered.
 # However if put in subprocesses, wait(1) waits until the process finishes OR signal is received.
@@ -72,7 +76,7 @@ wait $!
 # --tag lets us reference these backups later when doing restic-forget.
 restic backup \
 	--verbose="$RESTIC_VERBOSITY_LEVEL" \
-	--one-file-system \
+	$FS_ARG \
 	--tag "$RESTIC_BACKUP_TAG" \
 	--option b2.connections="$B2_CONNECTIONS" \
 	"${exclusion_args[@]}" \
--- a/bin/resticw
+++ b/bin/resticw
--- a/etc/cron.d/restic
+++ b/etc/cron.d/restic
@@ -4,5 +4,10 @@ PATH=/etc:/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin/:$INSTALL_PREFIX/bin/
 # minute        hour    mday    month   wday    command
 # Reference: https://www.freebsd.org/doc/handbook/configtuning-cron.html
 # Reference: crontab(5).
-@midnight	root	. $INSTALL_PREFIX/etc/restic/default.sh && cron_mail restic_backup.sh
-@monthly	root	. $INSTALL_PREFIX/etc/restic/default.sh && cron_mail restic_check.sh
+
+@midnight	root	. $INSTALL_PREFIX/etc/restic/default.sh && restic_backup.sh
+@monthly	root	. $INSTALL_PREFIX/etc/restic/default.sh && restic_check.sh
+
+# Email notification version. Make sure bin/cron_mail is in the above $PATH
+#@midnight	root	. $INSTALL_PREFIX/etc/restic/default.sh && cron_mail restic_backup.sh
+#@monthly	root	. $INSTALL_PREFIX/etc/restic/default.sh && cron_mail restic_check.sh
--- a/img/tasksched.png
+++ b/img/tasksched.png
--- a/usr/lib/systemd/system/restic-backup@.service
+++ b/usr/lib/systemd/system/restic-backup@.service
@@ -1,7 +1,9 @@
 [Unit]
 Description=Backup with restic to Backblaze B2
-OnFailure=status-email-user@%n.service
-Requires=nm-unmetered-connection.service
+# Email on failure require special setup. See README.md
+#OnFailure=status-email-user@%n.service
+# Prevent backup on unmetered connection. Needs special setup. See README.md.
+#Requires=nm-unmetered-connection.service

 [Service]
 Type=simple
--- a/usr/lib/systemd/system/restic-backup@.timer
+++ b/usr/lib/systemd/system/restic-backup@.timer
@@ -1,6 +1,5 @@
 [Unit]
 Description=Backup with restic on schedule
-Requires=nm-unmetered-connection.service

 [Timer]
 OnCalendar=daily
--- a/usr/lib/systemd/system/restic-check@.service
+++ b/usr/lib/systemd/system/restic-check@.service
@@ -1,8 +1,10 @@
 [Unit]
 Description=Check restic backup Backblaze B2 for errors
-OnFailure=status-email-user@%n.service
+# Email on failure require special setup. See README.md
+#OnFailure=status-email-user@%n.service
 Conflicts=restic-backup.service
-Requires=nm-unmetered-connection.service
+# Prevent backup on unmetered connection. Needs special setup. See README.md.
+#Requires=nm-unmetered-connection.service

 [Service]
 Type=simple
--- a/usr/lib/systemd/system/restic-check@.timer
+++ b/usr/lib/systemd/system/restic-check@.timer
@@ -1,6 +1,5 @@
 [Unit]
 Description=Check restic backup Backblaze B2 for errors on a schedule
-Requires=nm-unmetered-connection.service

 [Timer]
 OnCalendar=monthly
Author	SHA1	Message	Date
Erik Westrup	3a8ca5a815	Modified: CHANGELOG.md	2022-02-13 19:20:15 +01:00
Erik Westrup	37e38b4cb5	Modified: CHANGELOG.md	2022-02-13 19:20:02 +01:00
Erik Westrup	8f734ccc69	How to disable old launchagent	2022-02-13 19:19:00 +01:00
Erik Westrup	56c4fca8f6	Merge branch 'optionals' * optionals: Made scripts optional Cron not using cron_email by default	2022-02-13 19:18:37 +01:00
Erik Westrup	9449d78596	Made scripts optional	2022-02-13 19:15:55 +01:00
Erik Westrup	c50e66b48f	Cron not using cron_email by default	2022-02-13 18:47:31 +01:00
Erik Westrup	c1edb2efe1	Remove execution bit on bin/ as these are set when installing	2022-02-13 18:45:52 +01:00
Erik Westrup	8275f708ea	Link to schedtask doc	2022-02-13 18:37:04 +01:00
Erik Westrup	eac8b97932	Modified: CHANGELOG.md	2022-02-13 17:53:36 +01:00
Erik Westrup	bb40afa67a	Rename launchagent for consistency	2022-02-13 17:50:10 +01:00
Erik Westrup	cacfe58269	Merge branch 'rename_repo' * rename_repo: replace old with new name Update into	2022-02-13 16:40:35 +01:00
Erik Westrup	96e9bc23ab	replace old with new name	2022-02-13 16:39:25 +01:00
Erik Westrup	911f9f44d2	Update into	2022-02-13 16:33:12 +01:00
Erik Westrup	abac4b11ba	Remove duplicated readme line	2022-02-13 15:54:05 +01:00
Erik Westrup	cfaab7eb72	Move schedtasks to own subdir	2022-02-13 11:46:02 +01:00
Erik Westrup	978ca2becb	Merge branch 'winfix' * winfix: Modified: Makefile Add uninstall rename schedtask ps1 scoop prefix git	2022-02-13 11:35:08 +01:00
Erik Westrup	6cb6b41066	Modified: Makefile	2022-02-13 11:32:58 +01:00
Erik Westrup	16302e5d35	Add uninstall	2022-02-13 11:29:04 +01:00
Erik Westrup	aeec8991b6	rename schedtask ps1	2022-02-13 11:14:04 +01:00
Erik Westrup	0f5a8f0ca5	scoop prefix git	2022-02-13 11:10:38 +01:00
Erik Westrup	4a2ca821d7	Merge pull request #78 from erikw/windows Add Windows support with TaskScheduler	2022-02-12 20:46:39 +01:00
Erik Westrup	3b08a42495	Modified: CHANGELOG.md	2022-02-12 20:43:25 +01:00
Erik Westrup	9ec3b1cb79	Add screenshot Fixes #52	2022-02-12 20:40:07 +01:00
Erik Westrup	35c1c45352	Modified: install_restic_scheduledtask.ps1	2022-02-12 20:14:34 +01:00
Erik Westrup	f45b6298a4	Modified: install_restic_scheduledtask.ps1	2022-02-12 20:10:33 +01:00
Erik Westrup	9fa5074699	Modified: README.md install_restic_scheduledtask.ps1	2022-02-12 20:07:58 +01:00
Erik Westrup	71d0e8c5c1	dynamic fs args	2022-02-12 19:59:03 +01:00
Erik Westrup	0d92cca32d	windows install instructions	2022-02-12 19:47:22 +01:00
Erik Westrup	30d18b8b0e	shebang	2022-02-12 19:15:59 +01:00
Erik Westrup	9ff51d691a	WIP make target for scheduledtask	2022-02-12 19:11:47 +01:00
Erik Westrup	edaafdf10a	Fix phony target	2022-02-12 19:00:15 +01:00
Erik Westrup	07541cfaf2	Homebrew servcie control	2022-02-12 17:59:41 +01:00
Erik Westrup	399e7cd4ce	Fix launchagent macro	2022-02-12 17:40:26 +01:00
Erik Westrup	0f3d39dfe1	Custom launchagent dir	2022-02-12 17:33:29 +01:00
Erik Westrup	f7c13f7290	Add homebrew formula Fixes #73	2022-02-11 23:06:17 +01:00
Erik Westrup	c07f0ca027	Modified: CHANGELOG.md	2022-02-11 22:13:53 +01:00
Erik Westrup	a084830441	Modified: CHANGELOG.md	2022-02-11 22:13:41 +01:00
Erik Westrup	7d67142b6e	Use correct profile in launchagent	2022-02-11 22:13:19 +01:00