Skip to content

Commit a220e6c

Browse files
committed
document authentication options
1 parent baccedd commit a220e6c

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,20 @@ Inside [`config/example`](./config/example), you can find an example configurati
5454

5555
You may also be interested in the [live configuration of the OpenRail Association's organization](https://github.com/OpenRailAssociation/openrail-org-config).
5656

57+
### Authentication via token or app
58+
59+
As this tool issues many API requests (both on REST and GraphQL API), authentication is highly recommended. This is supported via personal access tokens of a user (PAT) or a GitHub App which you can setup yourself.
60+
61+
Access tokens and apps need the following permissions:
62+
* Repository permissions
63+
* Administration: read and write
64+
* Metadata: read
65+
* Organization permissions:
66+
* Administration: read and write
67+
* Members: read and write
68+
69+
You can set the required secrets in `config/app.yaml` or via environment variables (`GITHUB_TOKEN` or `GITHUB_APP_ID` and `GITHUB_APP_PRIVATE_KEY`).
70+
5771
## Run the program
5872

5973
You can execute the program using the command `gh-org-mgr`. `gh-org-mgr --help` shows all available arguments and options.

0 commit comments

Comments
 (0)