Skip to content

Commit e0a7a74

Browse files
committed
Authentication
1 parent e134dd6 commit e0a7a74

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

DEPLOYMENT.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@ There are a few ways to deploy the Copilot Metrics Viewer, depending on the type
44

55
The app runs in a Docker container, so it can be deployed anywhere containers are hosted (AWS, GCP, Azure, Kubernetes, etc.).
66

7-
## Authentication
7+
## Authentication to GitHub
88

99
The Metrics Viewer can be integrated with GitHub application authentication, which authenticates the user and verifies their permissions to view the metrics. This option is recommended since it doesn't use Personal Access Tokens. The downside of using a GitHub application is that it can only authorize users to view metrics at the organization level (no support for Enterprise).
1010

1111
With a Personal Access Token, user credentials are not verified, and the application simply renders Copilot metrics fetched using the PAT stored in the backend.
1212

13+
## Authentication for Copilot Metrics Viewer
14+
15+
By default Azure Deployments deploy a web app available on the public Internet without authentication (unless GitHub app is used).
16+
17+
Application can be easily secured in azure using built-in features like Authentication settings on ACA/AppService (EasyAuth on Azure). Azure Container Apps and App Services allow for adding IP restrictions on ingress. Both can also be deployed using private networking architectures.
18+
19+
Options below provide most basic and cost effective ways of hosting copilot-metrics-viewer.
20+
1321
## Scenario 1: One-click Azure Deployment
1422

1523
The simplest way to deploy is to use the "one-click" option that creates resources in Azure. The deployment includes:

0 commit comments

Comments
 (0)