Document GitHub org reader permissions using Github Apps

Co-authored-by: Ben Lambert <ben@blam.sh> Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-05-20 12:08:00 +02:00
parent f2cb8c8b61
commit 8a2d679822
3 changed files with 10 additions and 0 deletions
@@ -53,6 +53,16 @@ catalog:
          token: ${GITHUB_TOKEN}
 ```

+If Backstage is configured to use GitHub Apps authentication you must grant
+`Read-Only` access for `Members` under `Organization` in order to ingest users
+correctly. You can modify the app's permissions under the organization settings,
+`https://github.com/organizations/{ORG}/settings/apps/{APP_NAME}/permissions`.
+![permissions](./permissions.png)
+
+**Please note that when you change permissions, the app owner will get an email
+that must be approved first before the changes are applied.**
+![email](./email.png)
+
 Locations point out the specific org(s) you want to import. The `type` of these
 locations must be `github-org`, and the `target` must point to the exact URL of
 some organization. You can have several such location entries if you want, but