gcsproxy

package module

v0.0.3 Latest Latest Go to latest Published: Aug 4, 2023 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/karupanerura/gcsproxy

Links

Open Source Insights

README ¶

gcsproxy

HTTP Proxy for Goolge Cloud Storage.

Motivation

Cloud Load Balancing can use Identity Aware Proxy (IAP) to restrict access. IAPs can be applied to the Backend Service, but not to the Backend Bucket. Therefore, access to Google Cloud Storage (GCS) cannot be restricted using IAP.

To apply IAP to Google Cloud Storage, you must access Google Cloud Storage (GCS) via the Backend Service. Therefore, a Proxy to GCS acting as a Backend Service is required to restrict access for GCS.

Usage

Deploy the built docker image ghcr.io/karupanerura/gcsproxy:v0.0.3 to Cloud Run or any other services of Google Cloud Platform.

Environment Variables

GCS_PROXY_BUCKET: GCS bucket name. (required)
GCS_PROXY_PATH_PREFIX: URL path prefix. use it as GCS object key from URL path exclude the path prefix. (default: "/")
GCS_PROXY_INDEX_FILE: Index file name. (e.g. "index.html")
GCS_PROXY_NOT_FOUND_PATH: Path for not found error. (e.g. "/404.html")

Documentation ¶

Index ¶

func CreateHTTPHandler(ctx context.Context, config Config, opts ...Option) (http.Handler, error)
type Config
type Option
- func WithClient(client *storage.Client) Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CreateHTTPHandler ¶

func CreateHTTPHandler(ctx context.Context, config Config, opts ...Option) (http.Handler, error)

Types ¶

type Config ¶

type Config struct {
	BucketName   string
	PathPrefix   string
	IndexFile    string
	NotFoundPath string
	BufByteSize  int
}

type Option ¶

type Option interface {
	// contains filtered or unexported methods
}

func WithClient ¶

func WithClient(client *storage.Client) Option

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
gcsproxy

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL