https://github.com/loopyd/yoffhasher
Automagical Backup PowerShell Script
https://github.com/loopyd/yoffhasher
backup-script backup-utility hash powershell powershell-script
Last synced: about 2 months ago
JSON representation
Automagical Backup PowerShell Script
- Host: GitHub
- URL: https://github.com/loopyd/yoffhasher
- Owner: loopyd
- Created: 2018-01-22T21:30:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-28T11:05:07.000Z (over 7 years ago)
- Last Synced: 2025-01-25T20:11:27.576Z (4 months ago)
- Topics: backup-script, backup-utility, hash, powershell, powershell-script
- Size: 34.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# YOFFHASHER
---------------------
## Autonimous backup management script
# PowerShell script for backup management
By: loopyd / fur_user
Oogled at by: yucked ;3
---
### What is this?
An automagical backup organization script with a lot of extendability and optimization for Windows PowerShell 5.0 and above.
It can be installed as a background service and run automagically at intervals, or run a few times and left sadly...to cry
alone and forgotten about. (please, no - animal abuse is not okay).
---
### Installation
# For the diligant bold-hearted tester:
1. Clone it (currently **testing** branch only due to beta-ness)
2. Place the modules to run at the bottom of the script ( a few examples have been provided with ther appropriate arguments )
3. Run, hash, YOFF!
---
### Configuration and Usage
YOFFHASHER uses a segmented backup system.
Each segment is refered to as a ``chainlink``.
You link each function together to design your ``backup chain``.
Some functions, like ``Flatten-Directory`` and ``Generate-FolderClusters``, should be placed correctly at the beginning and the end of your ``backup chain`` respectively, to put the backup media in a state where it can be worked on in a flat manner.
Functions like ``Migrate-All`` bring new data into your backup dataset. They should also be ran on a flattened tree, and contain special features that save hard-drive space while preserving the original ``incoming`` folder tree, to optimize data mergers.
It is recommended you design your backup cluster directory structure as follows:
``incoming`` - Watched by ``Migrate-All`` - Merge data in by "New and Updated files only" from your upload interface, filtered by ``Modification Date``. Keep the stubs!
``pictures``, ``videos``, ``documents``, etc. - Could potentially reside on a NAS, or another storage medium. This is where your clusters will populate.
Options for each ``chainlink`` segment are listed below:
# Flatten-Directory options:
```
-FlattenRootDirectory [string]
The path to flatten the cluster folders to. It is the folder that contains all of the cluster directories.
```
# Reset-Directory options:
```
-ResetDirectory [string]
The path which contains files that need their attribute flags reset.
-FileTypeFilter [string,string,...]
Glob expressions filtering files by extension (or potentially name!) Add as many as you'd like.
```
# Hash-Directory options:
```
-ResetDirectory [string]
The path which contains files that need their attribute flags reset.
-FileTypeFilter [string,string,...]
Glob expressions filtering files by extension (or potentially name!) Add as many as you'd like.
```
# Generate-FolderClusters options:
```
-ClusterRootDirectory [string]
The path which contains files that need organized. It is recommended you run Flatten-Directory and
Reset-Directory on the same directory first, as the operation does not recurse subfolders !
-FileTypeFilter [string,string,...]
Glob expressions filtering files by extension (or potentially name!) Add as many as you'd like.
-ClusterSize [int]
Each cluster folder will take the number of files in you specify here. You should set this higher
(50-100) for larger directories, or (25-50) for smaller directories.
```
# Migrate-All options:
```
-MigrateRootDirectory [string]
The path which contains files that need migrated.
-FileTypeFilter [string,string,...]
Glob expressions filtering files by extension (or potentially name!) Add as many as you'd like.
-DestinationDirectory [string]
The path to place the migrated files (flat).
-StubOriginals [bool]
Wether or not to leave an empty stub behind in the copy operation which retains the original file's
creation and modification dates. Useful to preserve tree structures in the original directory, but
save storage space.
```
# Stub-Move options:
```
-FilePath [string]
The File to move and create a stub of
-DestinationDirectory [string]
The destination path/filename (usually the same, could be different to avoid duplicates)
```
# Add-Resource options:
```
CURRENTLY IN TESTING STATE, DON'T USE THIS JUST YET. IT'S A JSON RESOURCE PACKER I HAVEN'T
IMPLEMENTED YET. PLANNED TO HOLD 7-ZIP FOR AUTOTARBALLING AND TRANSCODING EXECUTABLES FOR
UNIFICATION OF FILE FORMATS.
```
---
### Example usage
Samples are provided at the bottom of the powershell in testing. But here they are run in the proper order:
```
Flatten-Directory -FlattenRootDirectory "E:\lupin\Pictures\sorted\hashed"
Reset-Directory -ResetDirectory "E:\lupin\Pictures\sorted\hashed" -FileTypeFilter *.gif,*.jpg,*.png,*.jpeg,*.bmp
Hash-Directory -HashDirectory "E:\lupin\Pictures\sorted\hashed" -FileTypeFilter *.gif,*.jpg,*.png,*.jpeg,*.bmp
Generate-FolderClusters -ClusterRootDirectory "E:\lupin\Pictures\sorted\hashed" -FileTypeFilter *.gif,*.jpg,*.png,*.jpeg,*.bmp -ClusterSize 100
```
### LICENSE
See ``license.md`` for licensing details.