Thruster (AnyCabled)

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 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

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 SSL 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 SSL provisioning: in order for Thruster to provision SSL certificates, it needs to know which domain those certificates should be for. So to use SSL, you need to set the SSL_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.

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

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

$ thrust bin/rails server

Or with automatic SSL:

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

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.

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