Skip to content

Commit

Permalink
Update documentation for using Github app for authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
mansab committed Sep 24, 2024
1 parent 55712fd commit 359c8a4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ it can be provided by **either** of the following methods:
* You will need to set: `GITHUB_TOKEN="<your_token>"` as the environment variable.

#### Github APP (Recommened)
* [Create a Github APP](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) and grant Read-Only access to Github Actions
* [Use cctray-auth Github APP](https://github.com/apps/cctray-auth) to grant Read-Only access to Github Actions on your repositories.
* The Github APP should be installed on the Github Organization or Account with access to the required repositories.
* You will need to set the following environment variables:
```
APP_AUTH_ID=<id_of_your_github_app>
APP_AUTH_PRIVATE_KEY_B64=<private_key_of_your_github_app_bas64_encoded>
APP_AUTH_INSTALLATION_ID=<installtion_id_once_installed>
```
* Please refer to Github's offical documentation to know what these values are and where can you find them
* Please refer to [Github's offical documentation](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) to know what these values are and where can you find them

**Please take into account the [Github API rate limit](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting) for authentication tokens.**

Expand Down

0 comments on commit 359c8a4

Please sign in to comment.