anycable-thruster 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29a13cd660905f32b4d4ac840499d1e9176a6d8134c147b88fd49a367fa50afc
+  data.tar.gz: 04b255fc85f57b851b64c7eba1392e90acb9f729acece8d4548efe54ccc7a21c
+SHA512:
+  metadata.gz: 40dd0368d393edc00a8a104ca945a97eb21471e68a66ac77c430d536b1f4025b17468da3242c218373827265d3a33e213f59d28864426e157dc7fe0442418ab4
+  data.tar.gz: 60a9887c50a858ead6996beaa408d77130d62ff6030192e59567debdbaec0e1bdb4617c01b6df3189c62ac3268c198873592cddb9f57e66b692a55187ec70017

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# Thruster (AnyCabled)
+
+> [!IMPORTANT]
+> This is a fork of Basecamp's [thruster](https://github.com/basecamp/thruster) that embeds [AnyCable](https://anycable.io) 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`:
+
+```diff
+- 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:
+
+```sh
+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 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](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.
+
+
+## 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:
+
+```ruby
+gem 'thruster'
+```
+
+Or install it globally:
+
+```sh
+$ gem install thruster
+```
+
+
+## Usage
+
+To run your Puma application inside Thruster, prefix your usual command string
+with `thrust`. For example:
+
+```sh
+$ thrust bin/rails server
+```
+
+Or with automatic SSL:
+
+```sh
+$ SSL_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 |
+|-----------------------|---------------------------------------------------------------------------------|---------------|
+| `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/exe/thrust

@@ -0,0 +1,11 @@
+#! /usr/bin/env ruby
+
+PLATFORM = [ :cpu, :os ].map { |m| Gem::Platform.local.send(m) }.join("-")
+EXECUTABLE = File.expand_path(File.join(__dir__, PLATFORM, "thrust"))
+
+if File.exist?(EXECUTABLE)
+  exec(EXECUTABLE, *ARGV)
+else
+  STDERR.puts("ERROR: Unsupported platform: #{PLATFORM}")
+  exit 1
+end

data/lib/anycable/thruster/version.rb

@@ -0,0 +1,16 @@
+require_relative "../../thruster/version"
+
+module AnyCable
+  module Thruster
+    VERSION = "0.1.3"
+
+    # Very basic validation to ensure the versions are in sync
+    if ::Thruster::VERSION.split(".").take(2) != VERSION.split(".").take(2)
+      raise "Minor or major version mismatch"
+    end
+
+    if ::Thruster::VERSION.split(".")[2].to_i > VERSION.split(".")[2].to_i
+      raise "Patch version mismatch: must be greater or equal to Thruster's patch version"
+    end
+  end
+end

data/lib/thruster/version.rb

@@ -0,0 +1,3 @@
+module Thruster
+  VERSION = "0.1.3"
+end

data/lib/thruster.rb

@@ -0,0 +1,4 @@
+module Thruster
+end
+
+require_relative "thruster/version"

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: anycable-thruster
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Kevin McConnell
+- Vladimir Dementyev
+- Igor Platonov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-04 00:00:00.000000000 Z
+dependencies: []
+description: A zero-config HTTP/2 proxy for lightweight production deployments with
+  AnyCable real-time server included
+email: anycable@evilmartians.io
+executables:
+- thrust
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- exe/thrust
+- lib/anycable/thruster/version.rb
+- lib/thruster.rb
+- lib/thruster/version.rb
+homepage: https://github.com/anycable/thruster
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/anycable/thruster
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Zero-config HTTP/2 proxy with embedded AnyCable
+test_files: []