From 7e1053a878ab77af44817b8f53642bf1effbc5cc Mon Sep 17 00:00:00 2001 From: Tim Hansen Date: Wed, 24 Mar 2021 15:33:42 -0600 Subject: [PATCH] Add notes about github-apps Signed-off-by: Tim Hansen --- docs/integrations/github/discovery.md | 3 ++- docs/integrations/github/locations.md | 6 ++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/integrations/github/discovery.md b/docs/integrations/github/discovery.md index e2c30bf179..fe52feab6e 100644 --- a/docs/integrations/github/discovery.md +++ b/docs/integrations/github/discovery.md @@ -48,7 +48,8 @@ request for each discovered location. This means if you have more than ~140 catalog entities, you may get throttled by rate limiting. This will soon be resolved once catalog refreshes make use of ETags; to work around this in the meantime, you can change the refresh rate of -the catalog in your `packages/backend/src/plugins/catalog.ts` file. +the catalog in your `packages/backend/src/plugins/catalog.ts` file, or configure +Backstage to use the [github-apps plugin](../../plugins/github-apps.md). This is true for any method of adding GitHub entities to the catalog, but especially easy to hit with automatic discovery. diff --git a/docs/integrations/github/locations.md b/docs/integrations/github/locations.md index 7976c1dfa9..5b972f332c 100644 --- a/docs/integrations/github/locations.md +++ b/docs/integrations/github/locations.md @@ -56,3 +56,9 @@ You need to supply either `apiBaseUrl` or `rawBaseUrl` or both (except for public GitHub, for which we can infer them). The `apiBaseUrl` will always be preferred over the other if a `token` is given, otherwise `rawBaseUrl` will be preferred. + +## Authentication with GitHub Apps + +Alternatively, Backstage can use GitHub Apps for backend authentication. This +has higher rate limits, and a clearer authorization model. See the +[github-apps plugin](../../plugins/github-apps.md) for how to set this up.