SimpleBackup 0.0.1

dotnet add package SimpleBackup --version 0.0.1                
NuGet\Install-Package SimpleBackup -Version 0.0.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SimpleBackup" Version="0.0.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SimpleBackup --version 0.0.1                
#r "nuget: SimpleBackup, 0.0.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SimpleBackup as a Cake Addin
#addin nuget:?package=SimpleBackup&version=0.0.1

// Install SimpleBackup as a Cake Tool
#tool nuget:?package=SimpleBackup&version=0.0.1                

SimpleBackup

<img src="https://raw.githubusercontent.com/forReason/SimpleBackup/master/SimplebackupLogo.png" width="200" height="200">

SimpleBlackup is an easy to use, simple and lightweight backup and restore library with the following functions:

  • Define Source, Backup and Restore Folders
  • Plain Backup (Folders and Files)
  • Compressed Backup (zip file)
  • Encrypted Backup (Password)
  • Zipped & Encrypted backup (zipped and then encryped)
  • Roll over defining how many backups should be kept in every stage. This minimizes the disk space by only keeping a certain amount of backups, thinning down the older they get (interim, daily, weekly, monthly, yearly).
  • Works efficiently, eg zipping & compressing in one go, no temporary storage on disk required

Setup & Usage

For a simple backup, you need the following:

// the path with the files which should be tracked
var sourceDir = new DirectoryInfo(@"Source");
// the path where backups are beeing stored
var backupDir = new DirectoryInfo(@"Backup");
// the path where restored files are created
var restoreDir = new DirectoryInfo(@"Restore");

// create backup class instance
var backup = new SimpleBackup.Backup(sourceDir, backupDir);

// Store backup
backup.StoreBackup();

restore backup to a target Directory
backup.RestoreBackup(backup.BackupFiles[0], restoreDir);

This example is fore creating a compressen & encrypted backup

var sourceDir = new DirectoryInfo(@"Source");
var backupDir = new DirectoryInfo(@"Backup");
var restoreDir = new DirectoryInfo(@"Restore");
var backup = new SimpleBackup.Backup(sourceDir, backupDir, true, password: "Hello world");
// Act
backup.StoreBackup();
backup.RestoreBackup(backup.BackupFiles[0], restoreDir);

Importing Backups

You can import Backups which you created manually or by other means in the past. This requires that you have a main folder, where only backups are inside:

MyBackups
- Backup 1
- Backup 2
- backup 3
...

the name is irrelevant. the Library uses the last Folder write time as backup time. Make sure to only import the backups once, Behaviour when the backups are already existing is untested

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.1 211 11/29/2023

initial release