Skip to content

Commit

Permalink
Add mention to the required Github token scope (#346)
Browse files Browse the repository at this point in the history
  • Loading branch information
Victoremepunto authored Jan 24, 2024
1 parent e76f1bc commit bbd8b40
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,16 @@ python3 -m venv $VENV_DIR
pip install crc-bonfire
```

To prevent GitHub rate limiting issues when bonfire reaches out to GitHub APIs, [create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) on your GitHub account which grants bonfire read access to your repos. Configure bonfire to use the token with:
To prevent GitHub rate limiting issues when bonfire reaches out to GitHub APIs,
[create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
on your GitHub account which grants bonfire read access to your repos.

Configure bonfire to use the token with:
```
echo 'GITHUB_TOKEN=<your api token>' >> ~/.config/bonfire/env
```

**Please note**: When using the Github token (classic), it **must have** the `read:project` scope for the template fetching to work!

# Quick Start

Expand Down

0 comments on commit bbd8b40

Please sign in to comment.