Skip to content

6. Settings

Jump to bottom
Jimmy Pautz edited this page Jul 27, 2026 · 5 revisions

Settings

The Settings card is an overlay modal in Storefront accessible by tapping the Gear icon (⚙️) in the top-right toolbar. It provides a centralized location to manage catalog sources, caching, GitHub API configuration, search filtering, and plugin updates.

Accessing Settings

  1. Open Storefront from KOReader (Tools → Storefront).
  2. Tap the Gear icon (⚙️) located on the right side of the header toolbar.
  3. The Settings overlay card will appear.

Sections and Options

The card is organized into three distinct sections:

1. Catalog & Cache

Controls how Storefront retrieves plugin/patch metadata and manages cached content.

  • Catalog Source
    • Values: Storefront (default catalog) or Direct GitHub API.
    • Behavior: Tapping toggles between Storefront's catalog (updated hourly for fast loading) and live GitHub API search (which can hit rate limits or require a PAT).
  • Refresh Cache
    • Values: Shows the timestamp of when catalog metadata was last fetched (e.g., 2026-07-27 10:30 or 10:30pm, adhering to KOReader's 12-hour or 24-hour clock settings), or Never.
    • Behavior: Tapping immediately closes the Settings card and triggers a manual refresh of the catalog cache from the active source.
  • Clear README Cache
    • Behavior: Deletes all locally cached Markdown README files stored for plugins and patches. The next time you open a plugin details view, Storefront will fetch the latest README directly from GitHub.

2. Search & API

Configures search indexing behavior and GitHub API authentication.

  • Include 0-star forks
    • Values: Checkbox (☑ enabled / ☐ disabled).
    • Behavior: Tapping toggles whether repository forks with zero stars are included in search and category list views. When toggled, the setting is saved to Storefront.lua and the active repository cache is cleared to update the visible list immediately.
  • GitHub Token
    • Values: Configured ✓ or Not set.
    • Behavior: Tapping opens a dialog where you can enter or clear a GitHub Personal Access Token (PAT classic, ghp_...).
      • Save: Saves the PAT to boost API rate limits (from 60 to 5,000 requests/hour) and displays a confirmation toast (GitHub token saved.).
      • Clear: Removes the existing token.
      • Cancel: Closes the input dialog without changes.

3. About Storefront

Displays plugin metadata and opens the dedicated About Storefront sub-dialog to manage self-updates.

  • About Storefront
    • Values: Current Storefront version (e.g., v1.0.0).
    • Behavior: Tapping opens the About Storefront dialog.
  • Update Channel
    • Values: Stable or Beta.
    • Behavior: Tapping opens the About Storefront dialog where you can toggle your update channel preference.

About Storefront Dialog Features

Opening About Storefront provides access to:

  • Version & Author Details: Displays the installed plugin version and author information (ultimatejimmy).
  • Update Channel Toggle: Switch between Stable (recommended) and Beta release channels. Channel choices are saved to Storefront_channel.lua.
  • Check for Updates: Manually query GitHub for Storefront updates.
    • If a newer release is found on your selected channel, Storefront opens the release details dialog showing changelogs and a 1-tap install option.
    • If you are already up to date, a notification toast confirms your current version.

Dismissing the Card

  • Close Button: Tap the Close button at the bottom of the card.
  • Hardware Back Key: On devices with physical buttons or e-ink navigation bars, pressing the Back button closes the Settings overlay card.

Clone this wiki locally