Add-on:AddonSync: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Blanked the page)
(Restore old copy of page as I'm reviving this add-on myself)
Line 1: Line 1:
{{Add-on
|Name=AddonSync
|provider-name=[[User:RogueScholar|RogueScholar]]
|ID=service.addonsync
|extension point=xbmc.service
|provides=executable
|Summary=Synchronize add-on settings between instances
|Description=Keep all add-on settings synced across all of your Kodi installations
|Platform=all
|Language=
|License=Mozilla Public License, v2.0
|Forum=
|Website=https://github.com/RogueScholar/service.addonsync/wiki
|Source=https://github.com/RogueScholar/service.addonsync
|Email=
|broken=
|icon url=https://raw.githubusercontent.com/RogueScholar/service.addonsync/master/resources/icon.png}}


<!-- Page content goes here -->
== 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.
== 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.
== 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 updated only on a Slave or the Master instance, such that the versions of the add-on no longer match
== Settings ==
=== AddonSync ===
{| style="border: none; margin: 1em auto; vertical-align: top; width: 100%;"
| style="text-align: left;" |
:'''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 On 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
:<u>'''''Debugging'''''</u>
::
:'''Enable debug logging'''
::Enables AddonSync debug logging (Required if reporting a problem) - for this to work, system-wide Kodi [[Settings/System#Debugging|logging]] must also be enabled
:<u>'''''Operations'''''</u>
::
:'''Run Synchronisation Now'''
::Manually run the synchronise operation
| style="text-align: center; width: 40%;" | [[File:AddonSync-Settings1.JPG|400px]]
|}
=== Filter ===
{| style="border: none; margin: 1em auto; vertical-align: top; width: 100%;"
| style="text-align: left; vertical-align: top;" |
:'''Addon Synchronise Selection'''
::Allows either All addons to be synchronise, or to include/exclude a set of addons
:'''Select Addons'''
::If not all addons are being synchronised, then selectes those that are included/excluded
| style="text-align: center; width: 40%;" | [[File:AddonSync-Settings2.JPG|400px]]
|}
== Debugging ==
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
* AddonSync debug from the AddonSync addon settings menu
[[Category:Add-ons]]

Revision as of 14:50, 29 September 2021

AddonSync
https://raw.githubusercontent.com/RogueScholar/service.addonsync/master/resources/icon.png

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

Introduction

You can install this addon from 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.

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.

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 updated only on a Slave or the Master instance, such that the versions of the add-on no longer match

Settings

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 On 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) - for this to work, system-wide Kodi logging must also be enabled
Operations
Run Synchronisation Now
Manually run the synchronise operation
File:AddonSync-Settings1.JPG

Filter

Addon Synchronise Selection
Allows either All addons to be synchronise, or to include/exclude a set of addons
Select Addons
If not all addons are being synchronised, then selectes those that are included/excluded
File:AddonSync-Settings2.JPG

Debugging

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

  • Kodi logging from the main setting menu
  • AddonSync debug from the AddonSync addon settings menu