Difference between revisions of "Add-on:AddonSync"

From Official Kodi Wiki
Jump to navigation Jump to search
(Restore old copy of page as I'm reviving this add-on myself)
(Update screenshots of add-on settings dialog)
 
(One intermediate revision by the same user not shown)
Line 19: Line 19:
<!-- Page content goes here -->
<!-- Page content goes here -->
== Introduction ==
== Introduction ==
You can install this addon from [https://raw.githubusercontent.com/RogueScholar/service.addonsync/releases GitHub Releases].
The AddonSync service allows you to set one of your Kodi installations as the "Master" and have all your other installations automatically copy any changes you make to the add-on settings there. The master installation uploads them to a network share, and each time the slave instances are run they scan them for any changes and download them if found.


The AddonSync service allows you to set one of your Kodi installations as the "Master" and have all your other installations automatically copy any changes you make to the add-on settings there. The master installation uploads them to a network share, and each time the slave instances are run they scan them for any changes and download them if found.
== Installation ==
You can install the most recent version of this addon from a ZIP file from [https://raw.githubusercontent.com/RogueScholar/service.addonsync/releases GitHub Releases]. To install the latest development version instead, download the [https://github.com/RogueScholar/service.addonsync/archive/refs/heads/main.zip service.addonsync-main.zip] snapshot of the GitHub repository.


== Setup ==
== Setup ==
Line 33: Line 34:
* Metadata add-ons
* Metadata add-ons
* Built-in screensavers
* Built-in screensavers
* Add-ons which have updated only on a Slave or the Master instance, such that the versions of the add-on no longer match
* Add-ons which have been updated on only a Slave or Master instance, such that the versions of the add-on no longer match


== Settings ==
== Settings ==
=== AddonSync ===
=== AddonSync ===
{| style="border: none; margin: 1em auto; vertical-align: top; width: 100%;"
{| style="border: none; margin: 1em 0; vertical-align: top; width: 100%;"
  | style="text-align: left;" |
  | style="text-align: left; vertical-align: top; width: 44em;" | {{Glossary}}
:'''Installation Type'''
{{Term|Installation Type}}
::If this Kodi installation should work as the Master or Slave
{{Defn|If this Kodi installation should work as the Master or Slave}}
:'''Central Store Location'''
{{Term|Central Store Location}}
::The location where AddonSync should store the addons data it needs to synchronise
{{Defn|The location where AddonSync should store the addons data it needs to synchronise}}
:'''Run On Startup'''
{{Term|Run at Startup}}
::If AddonSync should backup/restore when Kodi first starts up
{{Defn|If AddonSync should backup/restore when Kodi first starts up}}
:'''Update Interval (Minutes)'''
{{Term|Update Interval (Minutes)}}
::How often AddonSync should check to see if any settings have changed
{{Defn|How often AddonSync should check to see if any settings have changed}}
:'''Restart Updated Service Addons'''
{{Term|Restart Updated Service Addons}}
::If running as a slave and a service addon is updated, restart it to pick up the changes
{{Defn|If running as a slave and a service addon is updated, restart it to pick up the changes}}
:<u>'''''Debugging'''''</u>
{{Glossary end}}
::
 
:'''Enable debug logging'''
<u>'''''Debugging'''''</u>
::Enables AddonSync debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
{{Glossary}}
:<u>'''''Operations'''''</u>
{{Term|Enable debug logging}}
::
{{Defn|Enables AddonSync debug logging (Required if reporting a problem)}}
:'''Run Synchronisation Now'''
{{Glossary end}}
::Manually run the synchronise operation
:''Note: For this to work, system-wide Kodi [[Settings/System#Debugging|debug logging]] must also be enabled.''
  | style="text-align: center; width: 40%;" | [[File:AddonSync-Settings1.JPG|400px]]
 
<u>'''''Operations'''''</u>
{{Glossary}}
{{Term|Run Synchronization Now}}
{{Defn|Manually run the synchronize operation}}
{{Glossary end}}
  | style="text-align: center; vertical-align: top; width: auto;" | [[File:AddonSync-Settings1.png|600px]]
|}
|}


=== Filter ===
=== Filter ===
{| style="border: none; margin: 1em auto; vertical-align: top; width: 100%;"
{| style="border: none; margin: 1em 0; vertical-align: top; width: 100%;"
  | style="text-align: left; vertical-align: top;" |
  | style="text-align: left; vertical-align: top; width: 44em;" | {{Glossary}}
:'''Addon Synchronise Selection'''
{{Term|Addon Synchronise Selection}}
::Allows either All addons to be synchronise, or to include/exclude a set of addons
{{Defn|Allows either All addons to be synchronize, or to include/exclude a set of addons}}
:'''Select Addons'''
{{Term|Select Addons}}
::If not all addons are being synchronised, then selectes those that are included/excluded
{{Defn|If not all addons are being synchronized, allows user to select those that are included/excluded}}
  | style="text-align: center; width: 40%;" | [[File:AddonSync-Settings2.JPG|400px]]
{{Glossary end}}
  | style="text-align: center; vertical-align: top; width: auto;" | [[File:AddonSync-Settings2.png|600px]]
|}
|}


== Debugging ==
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* [[Settings/System#Debugging|Debug logging]] in the '''Kodi settings menu'''
* AddonSync debug from the AddonSync addon settings menu
* Debug logging in the '''AddonSync settings dialog'''
 
 
[[Category:Add-ons]]

Latest revision as of 10:33, 11 October 2021

AddonSync

Author: RogueScholar
Website: link
Type: Services
Repo:

License: Mozilla Public License, v2.0
Source: Source code
Summary: Synchronize add-on settings between instances
Home icon grey.png   ▶ Add-ons ▶ AddonSync

Keep all add-on settings synced across all of your Kodi installations

1 Introduction

The AddonSync service allows you to set one of your Kodi installations as the "Master" and have all your other installations automatically copy any changes you make to the add-on settings there. The master installation uploads them to a network share, and each time the slave instances are run they scan them for any changes and download them if found.

2 Installation

You can install the most recent version of this addon from a ZIP file from GitHub Releases. To install the latest development version instead, download the service.addonsync-main.zip snapshot of the GitHub repository.

3 Setup

AddonSync works on a "Master" and "Slave" approach. There can be only a single Master installation, but any number of slave installations. First, set up the Master installation, this will export all of your add-on settings to a shared location.

Once you have your Master installation configured to share its settings to a shared location, you can configure any number of other installations to act as slaves and update their own add-on settings from that master copy.

4 Exclusions

There are some addons that will not be synced between installations, this is normally because they need to have their own configurations. These include:

  • Skin settings
  • Metadata add-ons
  • Built-in screensavers
  • Add-ons which have been updated on only a Slave or Master instance, such that the versions of the add-on no longer match

5 Settings

5.1 AddonSync

Installation Type
If this Kodi installation should work as the Master or Slave
Central Store Location
The location where AddonSync should store the addons data it needs to synchronise
Run at Startup
If AddonSync should backup/restore when Kodi first starts up
Update Interval (Minutes)
How often AddonSync should check to see if any settings have changed
Restart Updated Service Addons
If running as a slave and a service addon is updated, restart it to pick up the changes

Debugging

Enable debug logging
Enables AddonSync debug logging (Required if reporting a problem)
Note: For this to work, system-wide Kodi debug logging must also be enabled.

Operations

Run Synchronization Now
Manually run the synchronize operation
AddonSync-Settings1.png

5.2 Filter

Addon Synchronise Selection
Allows either All addons to be synchronize, or to include/exclude a set of addons
Select Addons
If not all addons are being synchronized, allows user to select those that are included/excluded
AddonSync-Settings2.png

6 Debugging

If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:

  • Debug logging in the Kodi settings menu
  • Debug logging in the AddonSync settings dialog