Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.81 KB

add_an_access_token.md

File metadata and controls

34 lines (21 loc) · 1.81 KB
Raw

Adding a GitHub Personal Access Token

Some features rely on their ability to request data from the GitHub API. Access to the API can be restricted in two ways:

  • The API is rate limited
  • The user is on a private repository

Under these conditions, these features may not work well: adding an access token is highly recommended!

Rate limits: at the time of writing (official docs), without authentication, your IP address gets 60 requests per hour. With authentication, your account gets 5000 requests per hour.

List of features using the GitHub API

How to add a token

You'll first have to create an access token through the GitHub API: please follow the official documentation. Note: in step 7, you are prompted to select scopes. Select the "repo" box and deselect all other options:

Screenshot of selecting scopes listed above

With your access token copied, let's add it to the add-on.

  1. Open the Firefox Add-ons preferences by clicking the 3-line menu button in the browser toolbar and selecting "Add-ons".

  2. Find APT GitHub Improvements and click "Preferences":

Screenshot of APT GitHub Improvements in add-ons preferences

  1. Paste your token into the "GitHub Personal Access Token" field and click save:

Screenshot of APT GitHub Improvements preferences with access token field

Congratulations! You're all set up!