Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Rintaro Okamura <[email protected]>
  • Loading branch information
rinx committed Jul 5, 2024
1 parent f1f5167 commit e0e59fd
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Google Cloud Auth Proxy

[![latest tag](https://ghcr-badge.egpl.dev/rinx/gcloud-auth-proxy/latest_tag?trim=major&label=latest)](https://github.com/users/rinx/packages/container/package/gcloud-auth-proxy)
[![image size](https://ghcr-badge.egpl.dev/rinx/gcloud-auth-proxy/size)](https://github.com/users/rinx/packages/container/package/gcloud-auth-proxy)

This is a software that provides [Google-signed authentication tokens][google-token] in several ways.

Currently, it supports the following token types.
Expand All @@ -9,11 +12,32 @@ Currently, it supports the following token types.
[google-token]: https://cloud.google.com/docs/authentication/token-types
[google-id-token]: https://cloud.google.com/docs/authentication/get-id-token#go

## Usage
## Usecase

TBW

## Endpoints
## Usage

Deploy gcloud-auth-proxy as a sidecar with your application.

Container is available on `ghcr.io/rinx/gcloud-auth-proxy:latest`.

CLI flags are the followings.

```bash
Usage:
gcloud-auth-proxy [flags]

Flags:
--audience string default audience (required)
-h, --help help for gcloud-auth-proxy
--host string server host (default "0.0.0.0")
--port string server port (default "8100")
--token-source-cache-duration string token source cache duration (default "30m")
-v, --version version for gcloud-auth-proxy
```

### Endpoints

| endpoint | method | description |
|------------------|--------|------------------|
Expand Down
2 changes: 0 additions & 2 deletions pkg/service/google/idtoken/idtoken.go
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,6 @@ func (s *server) idTokenHandler(w http.ResponseWriter, r *http.Request) {

w.Header().Set("Content-Type", "application/json")
w.Header().Set("Cache-Control", "no-store")

w.WriteHeader(http.StatusOK)
}

func (s *server) idTokenProxy(w http.ResponseWriter, r *http.Request) {
Expand Down

0 comments on commit e0e59fd

Please sign in to comment.