Difference between revisions of "Backup"

From Official Kodi Wiki
Jump to: navigation, search
(Page outdated)
(Page rewritten)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{outdated|This page has some inaccuracies and requires rewriting.}}
+
{|class="infobox" style="width:210px"
 +
! Return to:
 +
|-
 +
|
 +
* '''[[HOW-TO:Create_Music_Library|Music Library Guide]]'''
 +
* '''[[HOW-TO:Create_Video_Library|Video Library Guide]]'''
 +
|}
  
<section begin="intro" />As with anything where you spend a lot of time setting it up, it's always a good idea to do periodic backups of your Kodi/XBMC settings and library. This is especially true if you are thinking of running a development build such as a [[nightly]], [[monthly]], or [[beta]]. There are various ways to backup Kodi's settings, the easiest simply being to make a copy of your [[userdata folder]], but this page will attempt to consolidate the different methods and explain them.<section end="intro" />
+
{{mininav|[[Video library]]}}
  
== What settings Kodi uses and where are they stored ==
 
{{main|Settings|userdata folder}}
 
  
Nearly all of Kodi's settings are stored in the [[userdata folder]]. Some files, such as add-ons that are not included by default, are stored in the parent folder to [[userdata]], the Kodi folder.
+
= Introduction =
 +
<section begin="intro" />Like all technology, disaster can strike at any time, either due to a hardware failure, operating system crash which has corrupted {{kodi}} data, or unexpected results from the use of a nightly or development build of {{kodi}}. For these reasons, backups of {{kodi}} are essential to enable you to quickly rebuild your setup.<section end="intro" />
  
== Backup add-on ==
+
There are many methods available to protect your data. The more common methods include manual copying of folders and files, {{kodi}} backup add-on or popular 3rd party backup programs (not covered here).
{{main|Add-on:Backup}}
 
  
The community Backup add-on is a great way to backup all of your Kodi settings, add-ons, and other related files. It includes options such as automatic scheduled backups, backing up to cloud storage such as Dropbox, and configuring custom backup directories.
+
This wiki page is not a step by step guide and requires that you have a general knowledge of computers and file systems. It will provide you information that will allow you to decide ''what'' to backup and ''which method'' to use.  
  
== Manual backup ==
 
{{editor note|This section needs to be expanded on, but in a nutshell: make a copy of your [[userdata folder]] and the parent "Kodi" folder.}}
 
  
== Backing up the video library ==
 
{{main|HOW-TO:Backup the library|Import-export library}}
 
{{#lst:HOW-TO:Backup the library|intro}}
 
  
== Watch status only ==
+
= Where Is {{kodi}} Installed =
{{See also|Syncing and sharing}}
+
{{Kodi}} installs itself in two locations.
  
These add-ons can be used to backup or even sync your watched status for videos in your library:
 
  
* [[Add-on:WatchedList]] - local backup of watched items
+
== Installation Folder ==
 +
This location holds the core program files for {{kodi}} and the location varies depending on which operating system in use.
 +
 
 +
The files in this location should not be touched as they are purely the program files. After the initial install, no add-ons, databases, caches or skins are installed here. There is no need to backup this section as you can simply download the latest version of {{kodi}} and reinstall it.
 +
 
 +
 
 +
== Kodi Data Folder ==
 +
Once {{Kodi}} is installed, all subsequent changes and usage data are saved in the Kodi Data folder which is the parent folder of the [[Userdata]] folder. When you install a new skin or an add-on it is installed in this folder. Playlists and edits to Nodes are stored here, and the library databases are created here along with the artwork cache and any other changes you make during your travels with {{kodi}}
 +
 
 +
Basically anything you add or modify, after installation, occurs in this folder and sub-folders.
 +
 
 +
The location of this folder varies between operating systems and the table below lists their locations.
 +
<section begin="KodiData" />
 +
{| class="prettytable"
 +
! scope="row" ! style="width:150px; | Operating system
 +
! scope="row" ! style="width:700px; | Kodi Data folder path
 +
|-
 +
| '''Android''' || Android/data/org.xbmc.kodi/files/.kodi
 +
|-
 +
| '''iOS''' || /private/var/mobile/Library/Preferences/Kodi
 +
|-
 +
| '''LibreELEC''' || /storage/.kodi
 +
|-
 +
| '''Linux''' || ~/.kodi
 +
|-
 +
| '''OSMC''' || /home/osmc/.kodi
 +
|-
 +
| '''Mac''' || /Users/<your_user_name>/Library/Application Support/Kodi
 +
|-
 +
| '''Windows''' || %APPDATA%\Kodi
 +
|-
 +
| '''Windows Portable''' || <''Install location chosen by you''>\portable_data
 +
|-
 +
| '''Windows UWP ''' || %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\
 +
|}
 +
 
 +
:'''Note:''' In some Android setups the path may be slightly different to the one stated above.
 +
<section end="KodiData" />
 +
 
 +
 
 +
 
 +
= What do I Backup =
 +
The following sub-sections cover the most common backup scenarios, but if you are unsure we recommend the full Kodi Data folder backup.
 +
 
 +
 
 +
== Full ==
 +
The simplest method is the full Kodi Data backup which will backup everything except the original installation folder. It will preserve all add-ons, skins, library databases, playlists, cache along with all their respective settings and any other modifications you have made.
 +
 
 +
Once this backup is restored and {{kodi}} is restarted, you should have a setup that is identical to the setup you had at the time the backup was created.
 +
 
 +
Note that once this backup is installed {{kodi}} will perform the usual Repository Update check and if there are updates available for any skins or add-ons, these will be downloaded and installed unless you have previously disabled auto-update.
 +
 
 +
 
 +
== Library ==
 +
If your only concern is your artwork and library metadata, then using the Export function of {{kodi}} will create backup files of the Music and/or Video libraries that can be quickly scanned back into {{kodi}}.
 +
 
 +
For the Music Library we recommend using the ''Single File'' setting <br>
 +
For the Video Library we recommend using the ''Separate Files'' setting. Be aware of the required settings to import Play Counts, Watched Status and Last Played data.
 +
 
 +
:'''See:''' [[Import-export_library|Import Export Library]]
 +
 
 +
 
 +
== Other ==
 +
You could also be more selective and backup certain components, but this will require advanced knowledge as cherry picking items may not always work as you may find that you have ommitted a critical file or add-on located in another folder. This is particularly true for skins that use multiple discrete skin helper add-ons which save data in their own location within the Kodi Data folder.
 +
 
 +
 
 +
 
 +
= Backup Methods =
 +
Various methods that are available to backup your data.
 +
 
 +
 
 +
== Manual ==
 +
This is a simple task if {{kodi}} is installed on hardware that uses a full operating system such as Windows. Simply navigate to the Kodi Data folder and copy it to your backup location.
 +
 
 +
On other systems, you may need to connect via a network or install a 3rd party file manager downloded from the appropriate Store.
 +
 
 +
 
 +
== Add-ons ==
 +
If you prefer an automated method, then the following backup add-on is available from the Official Kodi repsitory under ''Programs''
 +
:Wiki Page- [[Add-on:Backup]]
 +
:Forum Thread- [https://forum.kodi.tv/showthread.php?tid=129499 tid=129499]
 +
 
 +
 
 +
These add-ons have been created by the community and can be used to backup or sync your video watched status with online sites:
 +
 
 +
* [[Add-on:MyEpisodes]] - online backup of watched items
 +
* [[Add-on:MyEpisodeCalendar]] - online backup of watched items
 
* [[Add-on:Trakt]] - online backup of watched items
 
* [[Add-on:Trakt]] - online backup of watched items
* [[Add-on:ShareThe.TV]] - online backup of watched items
 
* [[Add-on:MyEpisodes]] - online backup of watched items
 
 
* [[Add-on:TVShow Time]] - online backup of watched items
 
* [[Add-on:TVShow Time]] - online backup of watched items
* [[Add-on:MyEpisodeCalendar]] - online backup of watched items
+
* [[Add-on:WatchedList]] - local backup of watched items
* [https://github.com/4lb3rtO/service.nfo.watchedstate.updater Watched state updater add-on] - Update your watchedstate in the nfo files as soon as this happens in the library
+
 
 +
 
 +
== Backup Software ==
 +
If you are using a general 3rd party backup program for your computer, ensure you add the Kodi Data folder as a location for back up.
 +
 
 +
 
 +
 
 +
= OS Specific =
 +
Information specific to operating systems.
 +
 
 +
 
 +
== LibreELEC ==
 +
If using LibreELEC, use the Backup and Restore options in the Settings page.
 +
:'''See:''' [https://wiki.libreelec.tv/libreelec_settings LibreELEC Backup]
 +
 
 +
 
 +
== Windows ==
 +
Multiple Kodi Data folders can be saved in the Windows \Roaming\ folder. {{kodi}} will always use the folder named '''{{kodi}}'''. See image.
 +
 
 +
To safeguard against hard drive failures, you should also keep a backup in a secondary location.
 +
 
 +
<gallery mode="packed" widths="500px" heights="283px">
 +
WindowsRoamingFolder.jpg
 +
</gallery>
  
== Other backup methods ==
 
{{editor note|If anyone would like to fill these in with the basics, or at least link to some tutorial, that would be appreciated.}}
 
  
=== OpenELEC ===
 
  
=== ADBFire ===
 
  
  
{{updated|16}}
+
{{Top}}
  
[[Category:How-to]]
+
{{updated|18}}
[[Category:Settings]]
+
[[Category:FAQ]]
 +
[[Category:Index]]
 +
[[Category:Guides]]
 +
[[Category:Manual]]
 +
[[Category:Karellen]]
 +
[[Category:Video library]]
 +
[[Category:Music library]]
 +
[[Category:Advanced topics]]
 +
[[Category:First time user]]

Revision as of 03:39, 16 February 2020

Return to:
Home icon grey.png   ▶ Video library ▶ Backup


1 Introduction

Like all technology, disaster can strike at any time, either due to a hardware failure, operating system crash which has corrupted Kodi data, or unexpected results from the use of a nightly or development build of Kodi. For these reasons, backups of Kodi are essential to enable you to quickly rebuild your setup.

There are many methods available to protect your data. The more common methods include manual copying of folders and files, Kodi backup add-on or popular 3rd party backup programs (not covered here).

This wiki page is not a step by step guide and requires that you have a general knowledge of computers and file systems. It will provide you information that will allow you to decide what to backup and which method to use.


2 Where Is Kodi Installed

Kodi installs itself in two locations.


2.1 Installation Folder

This location holds the core program files for Kodi and the location varies depending on which operating system in use.

The files in this location should not be touched as they are purely the program files. After the initial install, no add-ons, databases, caches or skins are installed here. There is no need to backup this section as you can simply download the latest version of Kodi and reinstall it.


2.2 Kodi Data Folder

Once Kodi is installed, all subsequent changes and usage data are saved in the Kodi Data folder which is the parent folder of the Userdata folder. When you install a new skin or an add-on it is installed in this folder. Playlists and edits to Nodes are stored here, and the library databases are created here along with the artwork cache and any other changes you make during your travels with Kodi

Basically anything you add or modify, after installation, occurs in this folder and sub-folders.

The location of this folder varies between operating systems and the table below lists their locations.

Operating system Kodi Data folder path
Android Android/data/org.xbmc.kodi/files/.kodi
iOS /private/var/mobile/Library/Preferences/Kodi
LibreELEC /storage/.kodi
Linux ~/.kodi
OSMC /home/osmc/.kodi
Mac /Users/<your_user_name>/Library/Application Support/Kodi
Windows  %APPDATA%\Kodi
Windows Portable <Install location chosen by you>\portable_data
Windows UWP  %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\
Note: In some Android setups the path may be slightly different to the one stated above.



3 What do I Backup

The following sub-sections cover the most common backup scenarios, but if you are unsure we recommend the full Kodi Data folder backup.


3.1 Full

The simplest method is the full Kodi Data backup which will backup everything except the original installation folder. It will preserve all add-ons, skins, library databases, playlists, cache along with all their respective settings and any other modifications you have made.

Once this backup is restored and Kodi is restarted, you should have a setup that is identical to the setup you had at the time the backup was created.

Note that once this backup is installed Kodi will perform the usual Repository Update check and if there are updates available for any skins or add-ons, these will be downloaded and installed unless you have previously disabled auto-update.


3.2 Library

If your only concern is your artwork and library metadata, then using the Export function of Kodi will create backup files of the Music and/or Video libraries that can be quickly scanned back into Kodi.

For the Music Library we recommend using the Single File setting
For the Video Library we recommend using the Separate Files setting. Be aware of the required settings to import Play Counts, Watched Status and Last Played data.

See: Import Export Library


3.3 Other

You could also be more selective and backup certain components, but this will require advanced knowledge as cherry picking items may not always work as you may find that you have ommitted a critical file or add-on located in another folder. This is particularly true for skins that use multiple discrete skin helper add-ons which save data in their own location within the Kodi Data folder.


4 Backup Methods

Various methods that are available to backup your data.


4.1 Manual

This is a simple task if Kodi is installed on hardware that uses a full operating system such as Windows. Simply navigate to the Kodi Data folder and copy it to your backup location.

On other systems, you may need to connect via a network or install a 3rd party file manager downloded from the appropriate Store.


4.2 Add-ons

If you prefer an automated method, then the following backup add-on is available from the Official Kodi repsitory under Programs

Wiki Page- Add-on:Backup
Forum Thread- tid=129499


These add-ons have been created by the community and can be used to backup or sync your video watched status with online sites:


4.3 Backup Software

If you are using a general 3rd party backup program for your computer, ensure you add the Kodi Data folder as a location for back up.


5 OS Specific

Information specific to operating systems.


5.1 LibreELEC

If using LibreELEC, use the Backup and Restore options in the Settings page.

See: LibreELEC Backup


5.2 Windows

Multiple Kodi Data folders can be saved in the Windows \Roaming\ folder. Kodi will always use the folder named Kodi. See image.

To safeguard against hard drive failures, you should also keep a backup in a secondary location.



Return to top