anycable-thruster

Thruster (AnyCabled)

[!IMPORTANT] This is a fork of Basecamp's thruster that embeds AnyCable right into the thrust proxy server.

Installation

To add AnyCable Thruster to your Ruby/Rails project, simply replace the original thruster gem with anycable-thruster:

- gem "thruster"
+ gem "anycable-thruster"

That's it! Everything else stays the same as with a regular Thruster.

AnyCable configuration

AnyCable is enabled by default and accepts WebSocket requests at the /cable path. You can disable AnyCable and use Thruster as is by setting the DISABLE_ANYCABLE environment variable to 1 to true.

To configure AnyCable server, you can use ANYCABLE_XXX env variables as usual or pass command-line options via the ANYCABLE_OPT enviroment variable. For example, the following two commands are equivalent:

ANYCABLE_DEBUG=true thrust bin/rails s

ANYCABLE_OPT="-debug" thrust bin/rails s

---

[!NOTE] This is the original Thruster readme without any modifications.

Thruster is an HTTP/2 proxy for simple production-ready deployments of Rails applications. It runs alongside the Puma webserver to provide a few additional features that help your app run efficiently and safely on the open Internet:

• HTTP/2 support
• Automatic TLS certificate management with Let's Encrypt
• Basic HTTP caching of public assets
• X-Sendfile support and compression, to efficiently serve static files

Thruster aims to be as zero-config as possible. It has no configuration file, and most features are automatically enabled with sensible defaults. The goal is that simply running your Puma server with Thruster should be enough to get a production-ready setup.

The only exception to this is TLS provisioning: in order for Thruster to provision TLS certificates, it needs to know which domain those certificates should be for. So to use TLS, you need to set the TLS_DOMAIN environment variable. If you don't set this variable, Thruster will run in HTTP-only mode.

Thruster also wraps the Puma process so that you can use it without managing multiple processes yourself. This is particularly useful when running in a containerized environment, where you typically won't have a process manager available to coordinate the processes. Instead you can use Thruster as your CMD, and it will manage Puma for you.

Thruster was originally created for the ONCE project, where we wanted a no-fuss way to serve a Rails application from a single container, directly on the open Internet. We've since found it useful for simple deployments of other Rails applications.

Installation

Thruster is distributed as a Ruby gem. Because Thruster is written in Go, we provide several pre-built platform-specific binaries. Installing the gem will automatically fetch the appropriate binary for your platform.

To install it, add it to your application's Gemfile:

gem 'thruster'

Or install it globally:

$ gem install thruster

Usage

To run your Puma application inside Thruster, prefix your usual command string with thrust. For example:

$ thrust bin/rails server

Or with automatic TLS:

$ TLS_DOMAIN=myapp.example.com thrust bin/rails server

Custom configuration

In most cases, Thruster should work out of the box with no additional configuration. But if you need to customize its behavior, there are a few environment variables that you can set.

Variable Name	Description	Default Value
TLS_DOMAIN	Comma-separated list of domain names to use for TLS provisioning. If not set, TLS will be disabled.	None
TARGET_PORT	The port that your Puma server should run on. Thruster will set PORT to this value when starting your server.	3000
CACHE_SIZE	The size of the HTTP cache in bytes.	64MB
MAX_CACHE_ITEM_SIZE	The maximum size of a single item in the HTTP cache in bytes.	1MB
X_SENDFILE_ENABLED	Whether to enable X-Sendfile support. Set to 0 or false to disable.	Enabled
MAX_REQUEST_BODY	The maximum size of a request body in bytes. Requests larger than this size will be refused; 0 means no maximum size is enforced.	0
STORAGE_PATH	The path to store Thruster's internal state. Provisioned TLS certificates will be stored here, so that they will not need to be requested every time your application is started.	./storage/thruster
BAD_GATEWAY_PAGE	Path to an HTML file to serve when the backend server returns a 502 Bad Gateway error. If there is no file at the specific path, Thruster will serve an empty 502 response instead. Because Thruster boots very quickly, a custom page can be a useful way to show that your application is starting up.	./public/502.html
HTTP_PORT	The port to listen on for HTTP traffic.	80
HTTPS_PORT	The port to listen on for HTTPS traffic.	443
HTTP_IDLE_TIMEOUT	The maximum time in seconds that a client can be idle before the connection is closed.	60
HTTP_READ_TIMEOUT	The maximum time in seconds that a client can take to send the request headers and body.	30
HTTP_WRITE_TIMEOUT	The maximum time in seconds during which the client must read the response.	30
ACME_DIRECTORY	The URL of the ACME directory to use for TLS certificate provisioning.	https://acme-v02.api.letsencrypt.org/directory (Let's Encrypt production)
EAB_KID	The EAB key identifier to use when provisioning TLS certificates, if required.	None
EAB_HMAC_KEY	The Base64-encoded EAB HMAC key to use when provisioning TLS certificates, if required.	None
FORWARD_HEADERS	Whether to forward X-Forwarded-* headers from the client.	Disabled when running with TLS; enabled otherwise
DEBUG	Set to 1 or true to enable debug logging.	Disabled

To prevent naming clashes with your application's own environment variables, Thruster's environment variables can optionally be prefixed with THRUSTER_. For example, TLS_DOMAIN can also be written as THRUSTER_TLS_DOMAIN. Whenever a prefixed variable is set, it will take precedence over the unprefixed version.