Documentation

If you want to copy your Slideshow’s configuration to more devices or simply make a backup in case something goes wrong, the best way to do it is use XML configuration backup / restore.

Via web interface, menu Settings – Backup & Restore, you can export the entire configuration of Slideshow to the XML file and download this file to your computer. Afterwards, you can use this XML file to restore this configuration in Slideshow on the same or different device.

Alternatively, you can upload configuration XML file to a ZIP file, enter its file name in setup.csv file (see directive :CONFIG) and setup file synchronization of this ZIP file. This way, you can modify the configuration of Slideshow entirely remotely. For security reasons, setting “External config import” has to be enabled in order for Slideshow to actually process the external configuration.

The configuration file might not be compatible between different versions of Slideshow. We suggest importing the configuration only to to same version of Slideshow as it was exported from.

What can you include in the backup?

  • Your device’s settings – content of web interface, menu Settings – Device settings (more information)
  • User accounts – including password in a hashed form, so be very careful with this option
  • Configuration of screen layouts, panels, playlists, content
  • Configuration of file synchronization, login to Google Drive and Dropbox account cannot be exported due to security reasons (more information)
  • List of on-device RSS messages – content of web interface, menu Tools – RSS messages (more information)
  • List of file metadata for scheduled deletions (more information)
  • Key mapping for keyboard shortcuts (more information)
  • Triggers (more information)
  • Media files (optional – if checked, Slideshow will produce ZIP instead of XML)

Manual modification of the backup

As the configuration backup is in human-readable XML format, it can be (very, very carefully) modified manually. This can be helpful for example if you want to do some batch modification. Just remember to open the XML backup file in a text editor which supports UTF-8 encoding natively (for example Notepad++ on Windows platform).

After updating the file manually, you can validate the XML file against the configuration XSD schema (provided below), for example using XML Tools in Notepad++, online service such as http://www.utilities-online.info/xsdvalidation/, or any other tool supporting XML validation against XSD schema.