diff --git a/plugins/github-deployments/README.md b/plugins/github-deployments/README.md index 174d1bc8c7..64ae9c66ca 100644 --- a/plugins/github-deployments/README.md +++ b/plugins/github-deployments/README.md @@ -60,3 +60,33 @@ spec: owner: CNCF lifecycle: experimental ``` + +### Self-hosted / Enterprise GitHub + +1. Add the `host` and `apiBaseUrl` to your `app-config.yaml` + +```yaml +# app-config.yaml + +integrations: + github: + - host: 'your-github-host.com' + apiBaseUrl: 'https://api.your-github-host.com' +``` + +2. Pass the host into the `EntityGithubDeploymentsCard` + +```typescript +// packages/app/src/components/catalog/EntityPage.tsx + +import { EntityGithubDeploymentsCard } from '@backstage/plugin-github-deployments'; + +const OverviewContent = () => ( + + // ... + + + + // ... + +); \ No newline at end of file