Plugin Update Checker: Configuration
Configuring the Plugin Update Checker: Cache Duration (hours, default 6) and GitHub Token (optional), number rules, rate limits and how to set up a token.
Plugin Update Checker: Configuration
Open the configuration in the Admin Panel under Manage > Plugins via the plugin Plugin Update Checker and its instance. The plugin is a singleton and has exactly one instance. The field labels appear in English by default. Both fields are optional, the plugin also works with the defaults.
Fields
| Field | Type | Default | Effect |
|---|---|---|---|
| Cache Duration (hours) | Text field, up to 4 characters | 6 |
How many hours a successful GitHub response is reused before GitHub is asked again. |
| GitHub Token (optional) | Text field, up to 255 characters | empty | Personal access token, sent with every GitHub request as an Authorization: Bearer header. |
The hint texts in the Admin Panel read: How long to cache GitHub API responses (default: 6 hours) and Personal Access Token for higher API rate limits (60/h without, 5000/h with token).
Rules for the cache duration
- The value is read as a whole number. An input such as
1.5counts as1. - Empty,
0or a non-numeric value results in the default of 6 hours. - The smallest effective value is 1 hour. Smaller and negative numbers are raised to 1.
- The duration applies to successful responses. Failed lookups are remembered for a fixed hour, regardless of this setting.
- Cache entries that are already stored keep their old expiry time. A changed duration only affects newly written entries.
GitHub token
Without a token the plugin queries GitHub anonymously. According to the field's hint text this allows 60 requests per hour, and 5000 with a token. With an empty cache, one request per checked plugin is needed. You therefore only need a token with many plugins or if you run into rate limit messages described under Troubleshooting.
- In GitHub, create a token under Settings > Developer settings > Personal access tokens.
- No permissions (scopes) are needed for public repositories.
- Paste the token into the GitHub Token (optional) field and save.
The field is an ordinary text field, not a password field. The token is stored in plain text in the plugin configuration and is visible to every admin who opens the configuration. Use a token without any permissions.
Private repositories can only be checked if the token has access to them. Without a token only public access is possible.