elie/xbmcbackup
1
0
Fork 0
mirror of https://github.com/robweber/xbmcbackup.git synced 2024-11-14 20:35:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

added settings level tags

Rob 2021-01-17 15:02:50 -06:00
parent ff4383bf6b
commit d4f33b3ad0
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Configuration.md

@ -1,4 +1,4 @@
These options are found in the Settings area of the addon and should be setup prior to using. These options are found in the Settings area of the addon and should be setup prior to using. Be aware that settings are visible based on the [Kodi Settings Level](https://kodi.wiki/view/Settings) set. Levels higher than Standard (Advanced or Expert) are designated next to that setting.
### General ### General
@ -6,8 +6,9 @@ These are general settings regarding how backups are performed, maintained, and
* Compress Archives - this will put the backup contents in a zip folder. See notes below regarding how this works in more detail. * Compress Archives - this will put the backup contents in a zip folder. See notes below regarding how this works in more detail.
* Backups to Keep - You can keep a set number of backups by setting the integer value of this setting greater than 0. * Backups to Keep - You can keep a set number of backups by setting the integer value of this setting greater than 0.
* Ask Before Restoring Kodi UI Settings - by default saved [UI settings](https://kodi.wiki/view/Settings) will be restored automatically. Setting this to true will prompt you to confirm you want to restore these settings. * Ask Before Restoring Kodi UI Settings - by default saved [UI settings](https://kodi.wiki/view/Settings) will be restored automatically. Setting this to true will prompt you to confirm you want to restore these settings. ![Settings Level Advanced](https://img.shields.io/badge/-advanced-blue)
* Progress Display - the type of progress bar you want to display, or none if you don't want to see the progress of the backup. * Progress Display - the type of progress bar you want to display, or none if you don't want to see the progress of the backup.
* Verbose Logging - adds some additional information to the logs, off by default. ![Settings Level Expert](https://img.shields.io/badge/-expert-blue)
If you choose to compress your backups there are a few things you need to be aware of. Compressing takes place on the server you are trying to backup and then only the archive is copied to the remote backup location. This means you must have sufficient space available to allow for creating the archive. When restoring a zipped archive the process is the same. It is first copied to your local storage, extracted, and the contents put to their correct locations. The archive is then deleted. Zipped and non-zipped backups can be mixed in the same archive folder. If you choose to compress your backups there are a few things you need to be aware of. Compressing takes place on the server you are trying to backup and then only the archive is copied to the remote backup location. This means you must have sufficient space available to allow for creating the archive. When restoring a zipped archive the process is the same. It is first copied to your local storage, extracted, and the contents put to their correct locations. The archive is then deleted. Zipped and non-zipped backups can be mixed in the same archive folder.
@ -26,14 +27,14 @@ __Please Note__: The Backup addon manages all files/folders under the chosen dir
### File Selection Options ### File Selection Options
You can select files via a Simple or [Advanced Editor](https://github.com/robweber/xbmcbackup/wiki/Advanced-Editor). Using the simple editor you can select from common Kodi folders that you would like to be backed up. Both of these options work off a [JSON config file](https://github.com/robweber/xbmcbackup/wiki/Sample-Custom-File) stored in the addon_data folder. Below is a breakdown of the file selection options available. More information about Kodi file paths can be found on [the wiki](http://kodi.wiki/view/Special_protocol). When in Advanced Mode you can select files via a Simple or [Advanced Editor](https://github.com/robweber/xbmcbackup/wiki/Advanced-Editor). By default the simple editor lets you can select from common Kodi folders that you would like to be backed up. Both editors work off of a [JSON config file](https://github.com/robweber/xbmcbackup/wiki/Sample-Custom-File) stored in the addon_data folder. Below is a breakdown of the file selection options available. More information about Kodi file paths can be found on [the wiki](http://kodi.wiki/view/Special_protocol).
![](https://github.com/robweber/xbmcbackup/blob/master/screenshots/screenshot5.jpg) ![](https://github.com/robweber/xbmcbackup/blob/master/screenshots/screenshot5.jpg)
* Addon Data - this is data saved by addons when changing their settings. The path is special://home/userdata/addon_data * Addon Data - this is data saved by addons when changing their settings. The path is special://home/userdata/addon_data
* Config Files - config files refer to a collection of files that Kodi uses for information. This includes the keymaps and peripheral_data, and library directories in the userdata folder. It also includes all the XML files in the root of the userdata directory such as sources.xml, guisettings.xml, favorites.xml, advancedsettings.xml and others. For a full list of files in this directory see the [UserData folder wiki page](http://kodi.wiki/view/The_UserData_Folder) * Config Files - config files refer to a collection of files that Kodi uses for information. This includes the keymaps and peripheral_data, and library directories in the userdata folder. It also includes all the XML files in the root of the userdata directory such as sources.xml, guisettings.xml, favorites.xml, advancedsettings.xml and others. For a full list of files in this directory see the [UserData folder wiki page](http://kodi.wiki/view/The_UserData_Folder)
* Database - these are the local Kodi SQLlite databases. Even if using the SQL database there are other DB files such as Addons.db that you would want in this folder. The path is special://home/userdata/Database * Database - these are the local Kodi SQLlite databases. Even if using the SQL database there are other DB files such as Addons.db that you would want in this folder. The path is special://home/userdata/Database
* Game Saves (Leia Only) - this will backup the Game Saves directory if you are using RetroPlayer in Kodi. This is special://home/userdata/Savestates * Game Saves (Leia+ Only) - this will backup the Game Saves directory if you are using RetroPlayer in Kodi. This is special://home/userdata/Savestates
* Playlist - Playlists that are created in Kodi. The path is special://home/userdata/playlists * Playlist - Playlists that are created in Kodi. The path is special://home/userdata/playlists
* Profiles - Any files in the profiles folder. Keep in mind this currently includes all database, thumnail and config files in here. The path is special://home/userdata/profiles * Profiles - Any files in the profiles folder. Keep in mind this currently includes all database, thumnail and config files in here. The path is special://home/userdata/profiles
* Thumbnails/Fanart - the folder where all thumbnails and fanart is stored. The path is special://home/userdata/Thumbnails * Thumbnails/Fanart - the folder where all thumbnails and fanart is stored. The path is special://home/userdata/Thumbnails
@ -41,6 +42,10 @@ You can select files via a Simple or [Advanced Editor](https://github.com/robweb
Additionally each backup will dump your current UI Settings to a special saved file called ```xbmcbackup.val```. This is done through a [JSON-RPC Settings.GetSettings](https://kodi.wiki/view/JSON-RPC_API/v12#Settings.GetSettings) call done at the time the backup is run. Additionally each backup will dump your current UI Settings to a special saved file called ```xbmcbackup.val```. This is done through a [JSON-RPC Settings.GetSettings](https://kodi.wiki/view/JSON-RPC_API/v12#Settings.GetSettings) call done at the time the backup is run.
### Scheduling
The scheduler allows for automatic backups on a defined schedule. More information on this is found on the [Scheduling page](https://github.com/robweber/xbmcbackup/wiki/Scheduling).
### Custom Directories (Legacy) ### Custom Directories (Legacy)
**If using Backup 1.5.0 or greater these have been moved to the [Advanced Editor](https://github.com/robweber/xbmcbackup/wiki/Advanced-Editor).** **If using Backup 1.5.0 or greater these have been moved to the [Advanced Editor](https://github.com/robweber/xbmcbackup/wiki/Advanced-Editor).**