gcs-spa-proxy

A Docker image for running Nginx as a proxy for Google Cloud Storage, with caching and SPA features.

Usage

No public image available at the moment. Fork away!

To run locally:

docker build -t gcs-spa-proxy .
docker run --rm -e "GCS_BUCKET=gcs-bucket-name" -e "REDIRECT_404_TO_INDEX=true" -p 9191:8080 --expose 8080 gcs-spa-proxy

NGINX is then accessible via localhost:9191

Configuration

The following tables lists the configurable environment variables of nginx-gcs-proxy and their default values.

Variable	Description	Default
GCS_BUCKET	Full URL to the bucket folder. https://storage.googleapis.com/[GCS_BUCKET]/index.html	None - required!
LISTEN_PORT	Server listen port	8080
REDIRECT_404_TO_INDEX	When requested path is not found in the bucket, return index.html. Useful when serving single page apps, like Angular, React, Ember. Possible values: "true", "false".	"false"
OBJECT_PREFIX	If set, will look for objects in <GCS_BUCKET>${OBJECT_PREFIX}. e.g. OBJECT_PREFIX=/path will look for objects in <GCS_BUCKET>/path	""
PROXY_CACHE	If true, enables NGINX proxy caching.	"false"
PROXY_CACHE_DURATION	Configures the NGINX proxy cache duration.	"30m"
PROXY_CACHE_INACTIVE	Configures the NGINX proxy cache inactive duration.	"1h"
CACHE_CONTROL	Configures Cache-Control: "private", "public". Set to "none" to disable, defaulting to bucket object metadata.	"none"
CACHE_CONTROL_DURATION	If present, configures the Cache-Control headers to this duration.	"1h"
CORS	If true, enables CORS.	"false"
CORS_ALLOWED_ORIGINS	Configures the list of allowerd origins	"*"
SERVICE_WORKER_FILENAME	Configures the service worker filename, which should not be cached ever. It should be regex-escaped.	"sw.js"

Health-checking

curl -v http://127.0.0.1:8080/healthz/

*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 8080 (#0)
> GET /healthz/ HTTP/1.1
> Host: 127.0.0.1:8080
> User-Agent: curl/7.55.1
> Accept: */*
>
< HTTP/1.1 200 OK
< Server: nginx
< Date: Wed, 17 Jan 2018 14:22:23 GMT
< Content-Type: application/octet-stream
< Content-Length: 0
< Connection: keep-alive
<
* Connection #0 to host 127.0.0.1 left intact

Building

docker build gcs-spa-proxy

Testing

docker run --rm -e GCS_BUCKET="dummy" gcs-spa-proxy nginx -t

Known issues

https://serverfault.com/questions/951049/nginx-proxy-to-gcs-bucket-with-redirect-all-urls-to-index-html-getting-200-blan

Workaround: Set PROXY_CACHE=true