Powershell scripts to run Restic backups on Windows. Simplifies the process of installation and running daily backups.
- VSS (Volume Snapshot Service) support - backup everything, don't worry about what files are open/in-use
- Easy Installation -
install.ps1
script downloads Restic, initializes the restic repository, and setups up a Windows Task Scheduler task to run the backup daily - Backup, Maintenance and Monitoring are Automated -
backup.ps1
script handles- Emailing the results of each execution, including log files when there are problems
- Runs routine maintenence (pruning and checking the repo for errors on a regular basis)
- And, of course backing up your files.
- Create your restic repository
- This is up to you to sort out where you want the data to go to. Minio, B2, S3, oh my.
- Install Scripts
- Create script directory:
C:\restic
- Download scripts from https://github.com/kmwoley/restic-windows-backup, and unzip them into
C:\restic
- Launch PowerShell as Administrator
- Change your working directory to
C:\restic
- If you downloaded the files as a ZIP file, you may have to 'unblock' the execution of the scripts by running
Unblock-File *.ps1
- Create script directory:
- Create
secrets.ps1
file- The secrets file contains location and passwords for your restic repository.
secrets_template.ps1
is a template for thesecrets.ps1
file - copy or rename this file tosecrets.ps1
and edit.- restic will pick up the repo destination from the environment variables you set in this file - see this doc for more information about configuring restic repos https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html
- Email sending configuration is also contained with this file. The scripts assume you want to get emails about the success/failure of each backup attempt.
- Run
install.ps1
file- From the elevated (Run as Administrator) Powershell window, run
.\install.ps1
- This will initialize the repro, create your logfile directory, and create a scheduled task in Windows Task Scheduler to run the task daily.
- From the elevated (Run as Administrator) Powershell window, run
- Add files/paths not to backup to
local.exclude
- If you don't want to modify the included exclude file, you can add any files/paths you want to exclude from the backup to
local.exclude
- If you don't want to modify the included exclude file, you can add any files/paths you want to exclude from the backup to
- Add
restic.exe
to the Windows Defender / Virus & Threat Detection Exclude list- Backups on Windows are really slow if you don't set the Antivirus to ignore restic.
- Navigate from the Start menu to: Virus & threat protection > Manage Settings > Exclusions (Add or remove exclusions) > Add an exclusion (Process) > Process Name: "restic.exe"
- (Recommended) To a test backup triggered from Task Scheduler
- It's recommended to open Windows Task Scheduler and trigger the task to run manually to test your first backup.
- Open Task Scheduler > Find "Restic Backup" > Right Click > Run
- The backup script will be executed as the SYSTEM user. Some of your files might not be accessible by this user. If you run into this, add the SYSTEM user to the files where you get "Access Denied" errors.
- Folder > Properties > Security > Advanced > Add ("SYSTEM" Principal/User) > Check "Replace all child object permission entries with inheritable permission entries from this object" > Apply > OK
- It's recommended to open Windows Task Scheduler and trigger the task to run manually to test your first backup.
- (Recommended) Do a test restore
- These scripts make it easy to work with Restic from the Powershell command line. If you run
. .\config.ps1; . .\secrets.ps1
you can then easily invoke restic commands like& $ResticExe find -i "*filename*"
& $ResticExe restore ...
- These scripts make it easy to work with Restic from the Powershell command line. If you run
Feel free to open issues or create PRs!