Skip to content

6. Settings

Jimmy Pautz edited this page Oct 23, 2026 · 2 revisions

Settings

The Backup & Restore Settings card allows you to personalize where your backups are saved, how many are kept, and how device migrations are handled.


Accessing Settings

  1. Open KOReader.
  2. Tap the top menu → tap the Tools (wrench icon) menu.
  3. Tap Device Backup & Restore → Backup & Restore Settings.

Settings Overview

1. Default Archive Format

  • Options: .zip (Default) or .tar.gz
  • What it does:
    • .zip: Standard format recognized by almost all computers, phones, and operating systems.
    • .tar.gz: Highly compressed format that saves a little extra space.

2. Backup Storage Folder

  • Options: Default (koreader/backups/) or any custom folder of your choice.
  • What it does: Controls where backup files are saved on your device.
  • How to change it: Tap the setting to open the interactive Folder Picker. You can browse your internal storage or an external MicroSD card and create new folders directly from your e-reader.

3. Rolling Retention Limit

  • Options: 5 (Default), 3, 10, or 0 (Keep all / Unlimited)
  • What it does: Automatically manages storage by keeping only your newest backups. When a new backup is created and the limit is reached, the oldest backup is automatically pruned.
  • Safety guarantee: Pre-restore safety rollback snapshots are never deleted by this limit.

4. Cross-Device Safety Protection

  • Options: Enabled (Recommended) or Disabled
  • What it does: Keeps your e-reader safe when restoring backups across different hardware models (such as moving from a Kindle to a Kobo, or from an Android reader to a Linux e-reader).
  • How it helps: Automatically adapts physical screen resolutions, frontlight warmth curves, and internal system paths to match your current device so your reader starts up cleanly without glitches.

5. Clean Slate Restore

  • Options: Disabled (Default) or Enabled
  • What it does: When enabled, restoring a backup will remove any user-installed plugins that were not part of that backup, giving you an exact mirror of the backed-up device. When disabled, existing user plugins are preserved.

6. Beam Cloud Relay Server

  • Options: Default Relay (https://...)
  • What it does: The secure, privacy-friendly cloud relay used for wireless device-to-device transfers. You can keep the default setting or specify your own private server address if preferred.

7. Scheduled Backup Reminders Submenu

  • Enable Scheduled Reminders: Toggle automated reminder checks on or off.
  • Reminder Frequency: Choose between Every 3 Days, Weekly (Every 7 Days) (Default), Every 2 Weeks, or Monthly (Every 30 Days).
  • Components to Back Up: Choose specifically which components are included in scheduled backups (for example, keeping them fast with just settings and reading history, or comprehensive with fonts and plugins).
  • Upload to Cloud on Completion: Automatically uploads scheduled backups to your configured cloud provider when connected to WiFi.
  • Test Reminder Now: Triggers the reminder dialog immediately to preview how the prompt functions on your e-reader.

8. Cloud Storage Settings Submenu

  • Storage Provider: Choose between None, Google Drive, Microsoft OneDrive, Dropbox, WebDAV, FTP, or SFTP.
  • Connect / Configure Provider: Sign in to your cloud provider using the on-screen OAuth device code or enter your self-hosted server credentials.
  • Test Cloud Connection: Runs a live connectivity check to confirm your account and server settings are working.
  • Remote Backup Folder: Name or full path of the remote directory (default: koreader_backups).
    • Nested Folder Support: You can specify deep paths like koreader/kindle/backups. The plugin automatically creates all subfolders on the remote service.
    • Smart Path Cleaning: Cleans up leading, trailing, or double slashes, and accepts either / or \ seamlessly.
  • Upload to Cloud on Creation: Automatically uploads any newly created backup archive to your cloud storage when connected to WiFi.
  • Browse Cloud Backups: Browse archives saved on your cloud storage to view details, restore them to your device, or delete old files.

Clone this wiki locally