cjones/restic-windows-backup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
restic-windows-backup/CHANGELOG.md
Kevin Woley e9241c0744 Update CHANGELOG.md with 1.8 release notes
2025-02-20 21:59:09 -08:00

13 KiB
Raw Permalink Blame History

Changelog

1.8 (2025-02-20)

Full Changelog

Summary

  • New features

    • Added update.ps1 which makes updating restic-windows-backup installations easier.
    • Added the ability to run custom actions at the start and end of the script execution. Can be used to invoke healthchecks or run custom scripts. Look at config_sample.ps1 for examples.

  • Bug fixes

    • Explicitly test the backup source media for VSS support instead of assuming it is or is not supported
    • Install script sets Task Scheduler user LogonType correctly, fixing #40
    • Error checking of restic.exe results fixed (was broken by release 1.7.1)

1.7.1 (2025-02-03)

Full Changelog

Summary

  • (Optionally) prevent backup & maintenance while on a metered network connection. By default, backups will occur while on a metered network connection. To disable backups over metered network connections, set $BackupOnMeteredNetwork = $false in config.ps1
  • Added $GlobalParameters = @() configuration variable, which will apply additional configuration parameters every time restic.exe is run. This is useful to add options for different types of backend targets.
  • Added $SelfUpdateEnabled = $true configuration variable, which can be used to disable restic.exe from automatically updating to the latest version when maintenance is run. To disable self update, set $SelfUpdateEnabled = $false in config.ps1  

What's Changed

New Contributors

1.7 (2025-01-25)

Full Changelog

Upgrade Warning - Future Breaking Change This release deprecates the following secrets.ps1 variables:

  • $PSEmailServer is replaced by $ResticEmailServer
  • $ResticEmailConfig is replaced by $ResticEmailPort In the next release, $ResticEmailServer and $ResticEmailPort will be required. This release will still work if the deprecated variables are defined.

What's Changed

New Contributors

1.6 (2023-01-14)

Full Changelog

Separated backup and maintenance execution loops, including sending separate emails for backup and maintenance reports. This allows for a maintenance failure not to cause a backup to be re-run, and vice-versa. This makes failures take a shorter time to resolve.

Logfiles now are formated as *.backup.log.txt and *.maintenance.log.txt

Fixes

  • Fixed issue #60, removing duplicate exclude lines
  • Fixed several errors where functions would return incorrect success/failure results due to PowerShell's return value semantics

Enhancements

  • Updated installer to download v 0.15.0
  • Installer will 'self-update' the Restic binary
  • Maintenance will 'self-update' the Restic binary
  • Added a configuration point for extra / additional parameters to be passed to the backup command ($AdditionalBackupParameters)

1.5 (2021-09-11)

Full Changelog

Added support for backing up removable drives (i.e. external USB disks). It's now possible to define a backup source by it's Volume label, device Serial Number, or the hardware Name.

WARNING If you have been previously backing up multiple drives, the default forget policy was likely pruning backup sets too aggressively and could lead to data loss. You must update your $SnapshotRetentionPolicy to include @("--group-by", "host,tags", ... to avoid pruning an entire drive's contents inadvertently!

Fixes

  • Updated default snapshot forget/prune retention policy to group by "host,tags" to prevent major data loss. Only configurations with multiple $BackupSources are impacted by this change.
  • Added tags to each backup source to support grouping by tags. For existing backup sets, this change will result in a slightly longer backup the first time this updated script is run.

Enhancements

  • External, removable disk drives (i.e. USB hard drives) can be identified by their Volume Label, Serial Number, or Device Name. For example, if you have an external device with the Volume Label "MY BOOK", you can define a backup source as $BackupSources["MY BOOK"]. I would recommend using the device serial number to identify external drives to backup, which you can find using the Powershell get-disk command.
  • Add the ability to $IgnoreMissingBackupSources. To make sure that errors are not thrown if the device is not present, there is now an option to ignore error reporting when a folder and entire backup source are missing. When $true, missing external drives or folders don't produce errors. When $null or $false, missing drives and/or folders result in an error. The default is set to $false as not to silently fail backing up a source.
  • Updated install script to download Restic 0.12.1

1.4.1 (2021-05-29)

Full Changelog

Bugfix release.

Fixes

  • Improved URL parsing so that the internet connectivity check works if the URL doesn't provide a protocol
  • Add PowerShell 7.1 support to internet connectivity check

Enhancements

  • Setting $InternetTestAttempts to 0 will now bypass the internet connectivity checks entirely

1.4 (2021-02-24)

Full Changelog

Moved to using Restic's inbuilt filesystem shadow copy creation (VSS).

Breaking Change

local.exclude file changes that previously referenced the resticVSS directory will need to be changed to C:\ or the relevant root drive letter.

Other enhancements

  • Future snapshot grouping (and cleanup) will be better since the root-level folders included in the backup won't change (instead, the script targets the root drive letter instead of a list of folders under the drive letter).
  • Added the ability to set prune parameters via .\config.ps1, and defaulted the settings to --group-by host to clean up the aforementioned snapshot grouping & pruning.
  • Updated the windows.exclude to include additional directories (most notably, the Recycle Bin is no longer backed up)

Closed issues:

  • Remove VSS Operations, Switch to --use-fs-snapshot #32
  • powershell execution policy is blocking the scheduled task #27
  • VSS Cleanup Upon Errors #8

Merged pull requests:

1.3 (2021-02-23)

Full Changelog

Improvements for Restic 0.12 and additional error logging.

Closed issues:

  • backup errors after update to restic 0.12.0 due to --quiet and --verbose being used simultaneously #29
  • Restic + rclone errors #26
  • E-Mail sending errors are not logged #25
  • FYI: Restic now has built-in VSS support #23
  • SFTP backup #22
  • Dirrectory/Folder Backup #21
  • Docker format #20
  • Filtering out errors before deciding to retry ? #19
  • Backup task stucked #18

Merged pull requests:

  • Release 1.4 #31 (kmwoley)
  • Add '-ExecutionPolicy Bypass' to the task scheduler arguments to avoi… #28 (scelfo)
  • Fix URI parsing #24 (Phlogi)

1.2.1 (2020-06-08)

Full Changelog

  • Internet connectivity test now supports more repository types (s3:, sftp:, rest:, azure:, gs:), and ignores unsupported (swift:, rclone: and local)

  • Add 32-bit support in the install.ps1

  • Fix/improve internet connectivity checks for azure: gs: b2:

Closed issues:

  • azure repo could not be parsed #15
  • Need to strip rest: in addition to s3: from RESTIC_REPOSITORY #14
  • Use non-s3 repos #10
  • Test-Connection fails #9
  • 32bit Windows Support #7
  • Add changelog #1

Merged pull requests:

1.1 (2020-02-15)

Full Changelog

  • Users can now set the following variables to control sending emails on success and/or error conditions.
  • Users can now completely disable maintenance activities.

New config.ps1 variable defaults for these options are:

$SnapshotMaintenanceEnabled = $true 
$SendEmailOnSuccess = $false
$SendEmailOnError = $true

Closed issues:

  • Ability to disable maintenance #3
  • Ability to disable mail sending #2

Merged pull requests:

  • add changelog #6 (kmwoley)
  • add options to enable/disable email sending and maintenance #4 (kmwoley)

1.0 (2020-02-09)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator

Reference in New Issue View Git Blame Copy Permalink