Backup.md

Backup Guide

This guide explains how to perform backups using LibreELEC Backupper.

Backup Methods

Manual Backup

1. Open the addon
2. Click "Backup Now"
3. Monitor progress through notifications
4. Wait for completion confirmation

Scheduled Backup (New!)

1. Enable scheduling in settings
2. Choose frequency:
   • Daily: Runs every day at specified time
   • Weekly: Runs on chosen day of week
   • Monthly: Runs on chosen day of month
3. Set backup time (24-hour format)
4. Configure retention count
5. Optional: Enable debug mode for multiple daily backups

Monitoring Backups

Real-time Progress

• Watch file count and size progress
• View current file being processed
• See estimated time remaining

Notifications

• Countdown alerts for scheduled backups
• Persistent upload status during transfers
• Completion notifications
• Error alerts if issues occur

Backup Management

Storage Options

• Local storage on LibreELEC system
• Remote storage (SMB, NFS, FTP, SFTP, WebDAV)
• Compression levels for space saving

Retention Settings

• Set maximum number of backups
• Configure scheduled backup retention
• Automatic cleanup of old backups

Best Practices

1. Schedule Selection

   • Choose appropriate frequency for your needs
   • Set convenient backup times
   • Consider system usage patterns

2. Storage Management

   • Monitor available space
   • Use appropriate compression
   • Set reasonable retention limits

3. Verification

   • Check backup logs regularly
   • Verify backup contents periodically
   • Test restore process occasionally

Troubleshooting

If you encounter issues:

• Check Troubleshooting Guide
• Review system logs
• Verify storage permissions
• Test network connectivity for remote storage

For restore instructions, see the Restore Guide.

Configuration.md

Configuration Guide

This guide explains all available configuration options in LibreELEC Backupper.

General Settings

Backup Location

• Location Type: Choose between Local or Remote storage
  • Local: Saves backups to a folder on your LibreELEC system
  • Remote: Saves backups to a network location

Remote Storage Options

If using remote storage:

• Storage Type: Choose from
  • SMB (Windows shares)
  • NFS
  • FTP
  • SFTP
  • WebDAV
• Remote Path: Enter the path to your backup folder
• Username: Your remote storage username
• Password: Your remote storage password
• Port: Custom port if needed (leave as 0 for default)
• Test Connection: Verify your remote storage settings

Scheduling Options

• Enable Scheduling: Turn automated backups on/off
• Backup Frequency:
  • Daily: Run backup every day
  • Weekly: Choose a specific day of the week
  • Monthly: Choose a specific day of the month
• Backup Time: Set the time for scheduled backups (24-hour format)
• Retention Count: Number of backups to keep for scheduled backups
• Debug Mode: Allow multiple backups per day (advanced users)

Notifications

• Show Notifications: Enable/disable backup notifications
• Detailed Notifications: Show additional information like file sizes and progress
• Countdown Notifications: Show countdown for scheduled backups
• Upload Status: Display persistent notifications during file uploads
• Completion Alerts: Notify when backups finish or fail

Backup Management

• Maximum Backups: Keep between 5-50 backups (older ones are automatically deleted)
• Compression Level:
  • None: No compression (fastest, largest files)
  • Fast: Basic compression
  • Normal: Balanced compression
  • Maximum: Best compression (slowest, smallest files)
• Backup Naming:
  • Date and Time: Automatic names based on timestamp
  • Custom Name: Your own backup names
  • Date + Custom: Combines both options

Backup Items

You can choose which items to include in your backups:

Essential System Items

• Configuration Files: System and addon configuration
• Installed Add-ons: Your Kodi addons
• Add-on User Data: Personal settings and data
• Repositories: Addon sources
• Sources: Media source locations

Actions

Available actions in the addon:

• Backup Now: Start an immediate backup
• Restore Backup: Restore from a previous backup
• View Backups: Browse your existing backups

Best Practices

1. Storage Space

   • Monitor available space regularly
   • Use compression for large backups
   • Adjust maximum backups based on space

2. Remote Storage

   • Test connection before first backup
   • Use secure protocols (SFTP) when possible
   • Verify credentials and permissions

3. Backup Strategy

   • Set up automated backups for regular protection
   • Choose appropriate scheduling frequency
   • Test restore process occasionally
   • Keep at least 2-3 known good backups
   • Monitor backup logs periodically

For backup and restore instructions, see:

• Backup Guide
• Restore Guide

FAQ.md

Frequently Asked Questions (FAQ)

General Questions

Q: What is LibreELEC Backupper?

A: LibreELEC Backupper is an addon for Kodi that helps you backup and restore essential parts of your LibreELEC system, including configurations, addons, and user data.

Q: Which LibreELEC versions are supported?

A: LibreELEC Backupper supports LibreELEC 10.0 and newer versions, running Kodi 19 (Matrix) or newer.

Q: Where can I get the latest version?

A: Download the latest version from our GitHub Releases page.

What's new in version 1.2.0?

Version 1.2.0 introduces automated backup scheduling, allowing you to set up daily, weekly, or monthly backups. It also includes debug mode for multiple daily backups, countdown notifications, and improved status tracking.

Installation

Q: How do I install the addon?

A: Download the zip file and install through Kodi's "Install from zip file" option. See our Installation Guide for detailed steps.

Q: Will it be available in a repository?

A: Yes, repository installation will be available soon. For now, please use the zip file installation method.

Backup Questions

Q: What items can I backup?

A: You can backup:

• Configuration Files
• Installed Add-ons
• Add-on User Data and Settings
• Repositories
• Sources

Q: Where are backups stored?

A: You can store backups either locally on your LibreELEC system or remotely using various protocols (SMB, NFS, FTP, SFTP, WebDAV).

Q: How much space do backups need?

A: Space requirements vary based on:

• Number of installed addons
• Amount of user data
• Compression level used
• Number of backups kept

Q: How are old backups managed?

A: The addon automatically manages backups based on your settings, keeping between 5-50 backups and removing the oldest ones when needed.

Remote Storage

Q: Which remote storage types are supported?

A: We support:

• SMB (Windows shares)
• NFS
• FTP
• SFTP
• WebDAV

Q: How do I test remote storage?

A: Use the "Test Connection" feature in the addon settings after configuring your remote storage details.

Scheduling Questions

How do I set up automated backups?

Go to the addon settings, enable scheduling, choose your preferred frequency (daily/weekly/monthly), set the backup time, and configure retention settings.

Can I run multiple backups per day?

Yes, with the new debug mode enabled, you can run multiple backups per day. This is useful for testing or when you need more frequent backups.

What happens if my system is off during a scheduled backup?

The backup will run at the next system startup if the scheduled time was missed. You can configure notifications to be informed about missed backups.

How do I change the backup schedule?

You can modify the schedule anytime in the addon settings. Changes take effect immediately, and the next backup time will be recalculated.

Can I temporarily disable scheduled backups?

Yes, you can disable scheduling in the addon settings without losing your schedule configuration. Re-enable it when you want to resume automated backups.

Storage and Performance

Q: How much space do backups need?

A: Space requirements vary based on:

• Number of installed addons
• Amount of user data
• Compression level used
• Number of backups kept

Troubleshooting

Q: What if backup fails?

A: Check:

1. Available space
2. Network connection (for remote storage)
3. Permissions
4. See Troubleshooting Guide for more details

Q: What if restore fails?

A: Try:

1. Using a different backup
2. Checking error messages
3. Verifying system space
4. See Restore Guide for more help

Q: Where are the log files?

A: Log files are stored in Kodi's standard log location. Access them through Kodi's log viewer or file system.

Support

Q: How do I get help?

A: You can:

1. Check our Documentation
2. Visit our GitHub Issues
3. Post on the LibreELEC Forum

Q: How do I report bugs?

A: Open an issue on our GitHub Issues page with:

• Detailed description
• Steps to reproduce
• System information
• Log files if available

Feature Requests

Can I request new features?

Yes! Visit our GitHub Issues page to submit feature requests or report bugs.

What features are planned for future releases?

We're constantly improving the addon based on user feedback. Some planned features include:

• More scheduling options
• Advanced retention policies
• Cloud storage support
• Backup encryption

For more detailed information, check our:

• Configuration Guide
• Backup Guide
• Restore Guide

Home.md

Welcome to LibreELEC Backupper Wiki

Welcome to the official wiki for LibreELEC Backupper! This wiki provides detailed information about installing, configuring, and using the addon.

Quick Navigation

• Installation Guide
• Configuration Guide
• Backup Guide
• Restore Guide
• Troubleshooting
• FAQ

About LibreELEC Backupper

LibreELEC Backupper is a reliable backup solution for your LibreELEC system. It allows you to backup essential system components and restore them when needed.

Key Features

• Automated backup scheduling (Daily/Weekly/Monthly)
• Beautiful and intuitive user interface
• Real-time progress tracking and file size display
• Flexible storage options (Local/Remote)
• Essential backup items selection
• Compression options
• Backup management
• Debug mode for advanced users
• Countdown notifications for scheduled backups
• Persistent upload status tracking

System Requirements

• LibreELEC 10.0+
• Kodi 19 (Matrix) or newer
• Available storage space for backups

Getting Started

1. Download the latest release (service.libreelec.backupper-1.2.0.zip)
2. Install via Kodi's "Install from zip file" option
3. Configure your backup settings and schedule
4. Start backing up your system

For detailed instructions, visit our Installation Guide and Configuration Guide.

Installation.md

Installation Guide

This guide will help you install LibreELEC Backupper on your system.

Download

1. Visit the Releases Page
2. Download the latest version: service.libreelec.backupper-1.2.0.zip

Installation Steps

1. Open Kodi on your LibreELEC system
2. Go to Add-ons
3. Select "Install from zip file"
4. Navigate to where you downloaded the zip file
5. Select service.libreelec.backupper-1.2.0.zip
6. Wait for the installation confirmation

Initial Setup

After installation:

1. Configure Backup Location

   • Choose Local or Remote storage
   • Set up connection details if using remote storage

2. Configure Scheduling (New!)

   • Enable/disable automated backups
   • Choose backup frequency (Daily/Weekly/Monthly)
   • Set preferred backup time
   • Configure retention settings

3. Choose Backup Items

   • Select which items to include
   • Configure compression settings
   • Set notification preferences

4. Test Configuration

   • Run a test backup
   • Verify backup location access
   • Check notifications

Next Steps

• Read the Configuration Guide for detailed settings
• Set up your Backup Strategy
• Learn about Restore Options

Troubleshooting

If you encounter any issues during installation:

• Check the Troubleshooting Guide
• Visit our FAQ
• Report issues on GitHub