Skip to content

2. Configuration

Jimmy Pautz edited this page Jul 20, 2026 · 4 revisions

Configuration (GitHub PAT)

If you routinely browse many repositories or hit rate-limit warnings, supply a PAT in plugins/storefront.koplugin/storefront_config.lua:

return {
    auth = {
        github = {
            type = "github",
            token = "ghp_your_token_here",
        },
    },
}

How to create a GitHub PAT

Use a classic token, not a fine-grained one. GitHub's search API (which this plugin relies on to discover plugins/patches) does not support fine-grained personal access tokens at all — requests with one will fail regardless of the permissions you grant it. Classic tokens work correctly.

  1. Sign in at github.com and open SettingsDeveloper settingsPersonal access tokensTokens (classic). You can follow this link.
  2. Click Generate new token (classic).
  3. Name the token (e.g., KOReader Storefront), set an expiration, and grant at least the public_repo scope.
  4. Generate and copy the token immediately—GitHub will not show it again.
  5. Paste it into storefront_config.lua and restart KOReader.

The plugin automatically includes the token in GitHub API requests, raising your quota to the standard authenticated limits.

Clone this wiki locally