elie/xbmcbackup
1
0
Fork 0
mirror of https://github.com/robweber/xbmcbackup.git synced 2024-11-15 04:45:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Beta Instructions (markdown)

Rob 2019-08-23 14:40:45 -05:00
parent 40b6da3747
commit 069e329ef6
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Beta-Instructions.md

@ -49,15 +49,21 @@ Each directory group will create a folder within the backup for it's files. Thes
Also during the backup the file selections are recorded in the backup validation file. These are used on restore to restore directories that actually were included in the backup.
## New Features
## Advanced Editor
### Advanced Editor
As described above there is a Simple vs Advanced file selection feature in the settings area now. Simple is just like the old way, minus the custom directories option. The Advanced editor will pop up a new series of dialog boxes.
As described above there is a Simple vs Advanced file selection feature in the settings area now. Simple is just like the old way, minus the custom directories option (I may add this back in). The Advanced editor will pop up a new series of dialog boxes.
### Sets
Adding a set will allow you to name a backup selection set and then set a root folder for inclusion. Because of how Kodi handles it's file browser I couldn't just let you browse the system carte blanche. You can either choose to select a folder within the "special://home" directory (default) or type your own path to start as the root. You can get as granular here as you want. Only selecting a specific addon to backup, or a specific sub folder.
A set is a root folder with a series of files/folders underneath you want backed up. This can be as macro (entire UserData folder) or as micro (specific addon) as you want.
Once the set is added you can select it to edit it or delete it. Editing a set allows you to see the root folder and adjust the included/excluded directories. By default the root folder is recursed and all files/directories added. You can select a folders to exclude; adding as many exclusions as you want to trim the backup set to a selection you want.
Creating a set will allow you to name it and then set a root folder for inclusion. Because of how Kodi handles it's file browser I couldn't just let you browse the system carte blanche. You can either choose to select a folder within the "special://home" directory (default) or type your own path to start as the root.
### Including Folders
By default the root folder and all files and sub folders are added to the set. You can modify this by removing the root include entry and then creating your own folders to include from with the root. Toggling the Sub Folder option allows you to stop the Backup addon from including folders below the one you've chosen. This essentially means you want only the files from this folder but nothing more.
### Excluding Folders
Excluding folders works about how you'd expect. Choose a folder and this folder, plus everything in it, are ignored.
__Can I exclude an entire directory EXCEPT for specific folders?__
@ -67,17 +73,17 @@ __Why can't I exclude the root folder?__
You can. See the above example. Removing the root folder from the include path effectively removes it, and all sub folders, from being backed up. Exclusions really only apply to folders beneath an already included folder.
### Backups
## Backups
When backing up in either the Simple or Advanced file mode you'll get a similar result. The backup archive will create a series of folders, one for each backup set type. With the Simple mode each set is just one of the "on/off" selection boxes. The xbmcbackup.val file also contains more information regarding the settings and paths for that particular backup.
### Restores
## Restores
Restores have been revamped. Previously they tried to restore files sort of in a "reverse backup" kind of way. Whatever you had selected in the file selection settings was attempted to be put back. This was not very intuitive and led to issues where maybe you didn't want all those files, or the backup you selected didn't contain them all (ie settings changed later).
After selecting your backup you'll now get a Backup Set selection browser. This will show the name of each set in whatever backup you've chosen. This is a multi-selection box. You can select them all or just a particular one. Once selected the restore process will restore these files only.
### Scripting
## Scripting
Scripting works the exact same way as outlined in the [Scripting](https://github.com/robweber/xbmcbackup/wiki/Scripting) wiki page currently. The one addition is that you can pass in a "sets" parameter. This bypasses the set selection dialog. If you pass in a set name that does not exist in the archive, it is just ignored. An example restore call to restore the config and databases sets would look like the following: