7. Advanced Configuration

Configuration (GitHub PAT)

Note

This is totally optional and will likely result in poor catalog fetching performance. I would recommend only using this if you are developing your own plugins or patches and need to test them and don't want to wait for the 1-hour catalog refresh cycle.

If you don't want to rely on the hourly Storefront catelog, 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 Settings → Developer settings → Personal access tokens → Tokens (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.