mirror of
https://github.com/robweber/xbmcbackup.git
synced 2024-11-22 13:37:02 +01:00
Destroyed Beta Instructions (markdown)
Rob
parent
f80d884d45
commit
53712b3e62
@ -1,95 +0,0 @@
|
||||
These are instructions for the new Beta version of the Backup Addon. This is not in the official Kodi repo yet, but for the brave souls testing it here are some instructions.
|
||||
|
||||
__Beware your old archive files created with previous versions of the Backup Addon are not compatible. Also be sure to uninstall other versions of the addon before testing.__
|
||||
|
||||
### [Download Here](https://github.com/robweber/xbmcbackup/archive/krypton.zip)!
|
||||
|
||||
## Overview
|
||||
|
||||
In the current iteration of the Backup addon there were some very simple file selection dialogs, along with 2 custom directory options to choose from. Since everyone's setup is different this one size fits all approach to file management was not the best setup.
|
||||
|
||||
Additionally restore operations were not very intuiative. You had to select the options you wanted in the addon settings ahead of doing the restore option. If you had different archives, with different files backed up, this was not ideal for trying to figure out what files were going to be restored. Traditional backup/restore programs allow you to select the files to restore *after* the backup achive had been examined.
|
||||
|
||||
### What is different?
|
||||
|
||||
The Beta version of the addon incorporates a new method of file selection. There is both a simple and advanced mode. The simple mode is just a pre-selected version of the advanced mode, so a description of it suffices for both.
|
||||
|
||||
A json file is created that lists directories to be included in a group. Each group can have included or excluded directories. Additionally included directories can be recursed true/false. An example file for the simple pre-sets is below:
|
||||
|
||||
```
|
||||
{
|
||||
"addons":{
|
||||
"root":"special://home/addons",
|
||||
"dirs":[
|
||||
{
|
||||
"type":"include",
|
||||
"path":"special://home/addons",
|
||||
"recurse":true
|
||||
},
|
||||
{
|
||||
"type":"exclude",
|
||||
"path":"special://home/addons/packages"
|
||||
}
|
||||
]
|
||||
},
|
||||
"addon_data":{
|
||||
"root":"special://home/userdata/addon_data",
|
||||
"dirs":[
|
||||
{
|
||||
"type":"include",
|
||||
"path":"special://home/userdata/addon_data",
|
||||
"recurse":true
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Each directory group will create a folder within the backup for it's files. These are done separately, even if groups are pulling from the same folder.
|
||||
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
### Sets
|
||||
|
||||
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.
|
||||
|
||||
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?__
|
||||
|
||||
Yes. This is somewhat non-intuitive at first glance. By default the root directory is included in the backup set, along with all files and folders within. Remove this included folder from the set. At this point you have a set with no folders selected. Then, do specific includes only for the folders you want.
|
||||
|
||||
__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
|
||||
|
||||
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 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 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:
|
||||
|
||||
```
|
||||
{ "jsonrpc": "2.0", "method": "Addons.ExecuteAddon","params":{"addonid":"script.xbmcbackup","params":{"mode":"restore","archive":"000000000000","sets":"config|database"}}, "id": 1 }
|
||||
|
||||
```
|
||||
|
||||
*Note the pipe ( | ) between each set name*
|
||||
Loading…
Reference in New Issue
Block a user