Skip to content

Commit

Permalink
docs(quay): add documentation for the new credential settings in prox…
Browse files Browse the repository at this point in the history
…y backend (janus-idp#1902)

docs(quay): add documentation for the new credential settings in proxy-backend
  • Loading branch information
karthikjeeyar authored Jul 26, 2024
1 parent 054ceec commit e04d231
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions plugins/quay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ The Quay plugin displays the information about your container images within the
proxy:
'/quay/api':
target: 'https://quay.io'
credentials: require
headers:
X-Requested-With: 'XMLHttpRequest'
# Uncomment the following line to access a private Quay Repository using a token
Expand All @@ -33,6 +34,15 @@ The Quay plugin displays the information about your container images within the
uiUrl: 'https://quay.io'
```
> [!NOTE]
> The value inside each route is either a simple URL string, or an object on the format accepted by [http-proxy-middleware](https://www.npmjs.com/package/http-proxy-middleware). Additionally, it has an optional `credentials` key which can have the following values:
>
> - `require`: Callers must provide Backstage user or service credentials with each request. The credentials are not forwarded to the proxy target. This is the **default**.
> - `forward`: Callers must provide Backstage user or service credentials with each request, and those credentials are forwarded to the proxy target.
> - `dangerously-allow-unauthenticated`: No Backstage credentials are required to access this proxy target. The target can still apply its own credentials checks, but the proxy will not help block non-Backstage-blessed callers. If you also add allowedHeaders: ['Authorization'] to an endpoint configuration, then the Backstage token (if provided) WILL be forwarded.
>
> Note that if you have `backend.auth.dangerouslyDisableDefaultAuthPolicy` set to true, the credentials value does not apply; the proxy will behave as if all endpoints were set to dangerously-allow-unauthenticated.

2. Enable an additional tab on the entity view page in `packages/app/src/components/catalog/EntityPage.tsx`:

```tsx title="packages/app/src/components/catalog/EntityPage.tsx"
Expand Down

0 comments on commit e04d231

Please sign in to comment.