GSS

GSS (Go serve SPA) is a containerized web server for single-page applications written in Go.

Features

• Optimized for single-page apps.
• Automatically serves pre-compressed brotli and gzip files if available.
• Sensible default cache configuration.
• Configurable rate limiter.
• Configurable response headers.
• Optional out-of-the-box metrics.
• Deployable as a container.
• Lightweight.

Usage

GSS works as a Docker container. By default it serves a directory in the container named dist at port 8080.

Running container directly

docker run -p [container-port]:8080 -v [local-folder-to-serve-path]:/dist lewislbr/gss

Example:

Having a local folder named public with SPA files:

docker run -p 3000:8080 -v $PWD/public:/dist lewislbr/gss

The server with the contents from public will be accessible at port 3000.

With a custom image

FROM lewislbr/gss:latest
COPY [local-folder-to-serve-path] ./dist

Example:

FROM lewislbr/gss:latest
COPY /public ./dist

docker build -t custom-image .

docker run -p 3000:8080 custom-image

The server with the contents from public will be accessible at port 3000.

Configuration options

Optionally, the server can be configured with a YAML file named /gss.yaml.

The configuration file should go into the container, such as:

docker run -p 3000:8080 -v $PWD/gss.yaml:/gss.yaml -v $PWD/public:/dist lewislbr/gss

FROM lewislbr/gss:latest
COPY gss.yaml ./
COPY /public ./dist

Response headers: headers

string: {string: string}

Headers to add to the response. Cache-Control, Content-Encoding, Content-Type, and Vary are automatically set.

Example:

# gss.yaml

headers:
  Content-Security-Policy: "default-src 'self'; connect-src 'self'"
  Referrer-Policy: "strict-origin-when-cross-origin"
  Strict-Transport-Security: "max-age=63072000; includeSubDomains; preload"
  X-Content-Type-Options: "nosniff"
  X-Frame-Options: "SAMEORIGIN"
  X-XSS-Protection: "1; mode=block"

Metrics collection: metrics

string: boolean

Enables metrics collection and exposes an endpoint at :9090/metrics. Collected metrics include request duration, request status, total requests, and bytes written. False by default.

Example:

# gss.yaml

metrics: true

Rate limit per minute: rateLimit

string: integer

Configures the rate limit per minute per IP using a memory store. 15 by default.

Example:

# gss.yaml

rateLimit: 10

Contributing

This project started as a way to learn and to solve a need I had. If you think it can be improved in any way, you are very welcome to contribute!