thruster 0.0.2-x86_64-linux → 0.0.3-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4245ccd3e460a7e0b4355704d4365876ae8fda02bee3953ea50c2257c9b662
-  data.tar.gz: f8f0de25f201d224fbe1c46938082b2bc629c86c0038cbc370f80c6e8c388b68
+  metadata.gz: 47ece0b29cc61ec4e448bc880907bd1bc7a8b678f1f7068da543c4e51e0d53ad
+  data.tar.gz: 9fcfc4393c9df86b2d8617a8f47aa38d6d3a168e860323222e5f1d472bc2133b
 SHA512:
-  metadata.gz: 06dc09f11c5a69769effe3fc0214866104609342bbccdee848f03589f6596be73250bf01f17dced57c6eeee30957f6770c366c430569daa4a83e3095a5e0aeff
-  data.tar.gz: 5a01e1896f716fcd7f73e66560a9d3331261dda2381e1695ddb55f217d5fe207f45f75bbdf9deff3d982f18ef0ebfe351207e782031e67a468c3f4f08028dcbc
+  metadata.gz: 70e6cb7a0bc8c59b44cb26b15d02102aa551907220603236bbcf805bd2851bd10429be42d2e56e76fb7e5b04a2586358c51848920d6c32b506fc60c0e865b993
+  data.tar.gz: b27a09a7888096e8bc530bf6bb9728b49b450f9acaeb26ed774060884c080a3612f3d151e001fab07a8e1e45fac237fbf31849b784099bdf4a9d06f2abd18cfb

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2024 Kevin McConnell
+Copyright (c) 37signals, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,24 +2,42 @@
 
 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 to help your app run efficiently and safely on the open Internet:
+features that help your app run efficiently and safely on the open Internet:
 
-- Automatic SSL certificate management with Let's Encrypt
 - HTTP/2 support
-- Basic HTTP caching
-- X-Sendfile support for efficient file serving
-- Automatic GZIP compression
+- 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.
 
-Thruster tries to be as zero-config as possible, so most features are
-automatically enabled with sensible defaults.
+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](https://once.com) 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.
 
-One exception to that is the `SSL_DOMAIN` environment variable, which is
-required to enable SSL provisioning. If `SSL_DOMAIN` is not set, Thruster will
-operate in HTTP-only mode.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+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:
 
 ```ruby
 gem 'thruster'
@@ -31,6 +49,7 @@ Or install it globally:
 $ gem install thruster
 ```
 
+
 ## Usage
 
 To run your Puma application inside Thruster, prefix your usual command string
@@ -46,46 +65,34 @@ Or with automatic SSL:
 $ SSL_DOMAIN=myapp.example.com thrust bin/rails server
 ```
 
-## Custom configuration
-
-Thruster provides a number of environment variables that can be used to
-customize its behavior:
-
-- `SSL_DOMAIN` - The domain name to use for SSL provisioning. If not set, SSL
-  will be disabled.
-
-- `TARGET_PORT` - The port that your Puma server should run on. Defaults to
-  3000. Thruster will set `PORT` to this when starting your server.
 
-- `CACHE_SIZE` - The size of the HTTP cache in bytes. Defaults to 64MB.
-
-- `MAX_CACHE_ITEM_SIZE` - The maximum size of a single item in the HTTP cache
-  in bytes. Defaults to 1MB.
-
-- `X_SENDFILE_ENABLED` - Whether to enable X-Sendfile support. Defaults to
-  enabled; set to `0` or `false` to disable.
-
-- `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. Defaults to
-  `0`.
-
-- `STORAGE_PATH` - The path to store Thruster's internal state. Defaults to
-  `./storage/thruster`.
-
-- `BAD_GATEWAY_PAGE` - Path to an HTML file to serve when the backend server
-  returns a 502 Bad Gateway error. Defaults to `./public/502.html`. If there is
-  no file at the specific path, Thruster will serve an empty 502 response
-  instead.
-
-- `HTTP_PORT` - The port to listen on for HTTP traffic. Defaults to 80.
-
-- `HTTPS_PORT` - The port to listen on for HTTPS traffic. Defaults to 443.
-
-- `HTTP_IDLE_TIMEOUT` - The maximum time in seconds that a client can be idle
-  before the connection is closed. Defaults to 60.
-
-- `HTTP_READ_TIMEOUT` - The maximum time in seconds that a client can take to
-  send the request headers. Defaults to 30.
+## Custom configuration
 
-- `HTTP_WRITE_TIMEOUT` - The maximum time in seconds during which the client
-must read the response. Defaults to 30.
+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 |
+|-----------------------|---------------------------------------------------------------------------------|---------------|
+| `SSL_DOMAIN`          | The domain name to use for SSL provisioning. If not set, SSL 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 SSL 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. | 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 SSL certificate provisioning.          | `https://acme-v02.api.letsencrypt.org/directory` (Let's Encrypt production) |
+| `EAB_KID`             | The EAB key identifier to use when provisioning SSL certificates, if required.  | None |
+| `EAB_HMAC_KEY`        | The Base64-encoded EAB HMAC key to use when provisioning SSL certificates, if required. | None |
+| `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, `SSL_DOMAIN` can also be written as `THRUSTER_SSL_DOMAIN`. Whenever
+a prefixed variable is set, it will take precedence over the unprefixed version.

data/lib/thruster/version.rb

@@ -1,3 +1,3 @@
 module Thruster
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thruster
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: x86_64-linux
 authors:
 - Kevin McConnell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies: []
 description: A zero-config HTTP/2 proxy for lightweight production deployments
 email: kevin@37signals.com