tristan/puppet-filebucket-util
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation on the Features that are planned for the util

Browse Source
This commit is contained in:
Tristan Ancelet 2024-05-18 13:57:10 -05:00
parent 9af4c714c3
commit 76f04b44ac
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -10,3 +10,19 @@ This project is meant to handle & query the filebucket locally on the device of
## Planned Features ## Planned Features
### Search
This will search for a file by a substring (or full path) of the file you are attempting to view or restore.
### List
This will simply list out every file that has been backed up to the bucket in `<TIME> : <MD5> : <FILEPATH>` format.
### List-Files
This will allow you to just list the specific (unique) files/paths that were backed up to the bucket during puppet runs before they get changed on disk.
You can use this to find the file you are looking for before you search for it using the search action.
### Restore (not implemented yet)
This will allow you to restore a file on disk to the specific version that is stored in the bucket.
### Get
The utility will allow you to get the contents of a backup up file and have it output to the terminal.