thruster 0.1.3 → 0.1.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +25 -25
- data/lib/thruster/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3bbe5428b2a134397d8f9e58209d3fb5f1d8aa27851cc49b7a384b8ef0ac876d
|
|
4
|
+
data.tar.gz: '0258f939e97ac8e82375638af31199220224d820c01d73188a0d6ce14fcb775e'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: cbd971b3531c889979ac89e8c61500c2ed9c44e16a590291b62d5d5cd286b42368df95e267339ca91cbb7665ae8a1f39c7fed7e839021d0dd5bd7edf68f48e40
|
|
7
|
+
data.tar.gz: 982672ab709ddcdb31130cd059ac7b5c4684c4f398b1235ec286bd8f18a352de560b4a902763b81e448a3d1163136d533bdb9b69764c0ef70baf9bfd7b95c13f
|
data/README.md
CHANGED
|
@@ -5,7 +5,7 @@ applications. It runs alongside the Puma webserver to provide a few additional
|
|
|
5
5
|
features that help your app run efficiently and safely on the open Internet:
|
|
6
6
|
|
|
7
7
|
- HTTP/2 support
|
|
8
|
-
- Automatic
|
|
8
|
+
- Automatic TLS certificate management with Let's Encrypt
|
|
9
9
|
- Basic HTTP caching of public assets
|
|
10
10
|
- X-Sendfile support and compression, to efficiently serve static files
|
|
11
11
|
|
|
@@ -14,9 +14,9 @@ and most features are automatically enabled with sensible defaults. The goal is
|
|
|
14
14
|
that simply running your Puma server with Thruster should be enough to get a
|
|
15
15
|
production-ready setup.
|
|
16
16
|
|
|
17
|
-
The only exception to this is
|
|
18
|
-
provision
|
|
19
|
-
should be for. So to use
|
|
17
|
+
The only exception to this is TLS provisioning: in order for Thruster to
|
|
18
|
+
provision TLS certificates, it needs to know which domain those certificates
|
|
19
|
+
should be for. So to use TLS, you need to set the `TLS_DOMAIN` environment
|
|
20
20
|
variable. If you don't set this variable, Thruster will run in HTTP-only mode.
|
|
21
21
|
|
|
22
22
|
Thruster also wraps the Puma process so that you can use it without managing
|
|
@@ -59,10 +59,10 @@ with `thrust`. For example:
|
|
|
59
59
|
$ thrust bin/rails server
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
Or with automatic
|
|
62
|
+
Or with automatic TLS:
|
|
63
63
|
|
|
64
64
|
```sh
|
|
65
|
-
$
|
|
65
|
+
$ TLS_DOMAIN=myapp.example.com thrust bin/rails server
|
|
66
66
|
```
|
|
67
67
|
|
|
68
68
|
|
|
@@ -72,27 +72,27 @@ In most cases, Thruster should work out of the box with no additional
|
|
|
72
72
|
configuration. But if you need to customize its behavior, there are a few
|
|
73
73
|
environment variables that you can set.
|
|
74
74
|
|
|
75
|
-
| Variable Name | Description
|
|
76
|
-
|
|
77
|
-
| `
|
|
78
|
-
| `TARGET_PORT` | The port that your Puma server should run on. Thruster will set `PORT` to this value when starting your server.
|
|
79
|
-
| `CACHE_SIZE` | The size of the HTTP cache in bytes.
|
|
80
|
-
| `MAX_CACHE_ITEM_SIZE` | The maximum size of a single item in the HTTP cache in bytes.
|
|
81
|
-
| `X_SENDFILE_ENABLED` | Whether to enable X-Sendfile support. Set to `0` or `false` to disable.
|
|
82
|
-
| `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.
|
|
83
|
-
| `STORAGE_PATH` | The path to store Thruster's internal state. Provisioned
|
|
75
|
+
| Variable Name | Description | Default Value |
|
|
76
|
+
|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
|
|
77
|
+
| `TLS_DOMAIN` | Comma-separated list of domain names to use for TLS provisioning. If not set, TLS will be disabled. | None |
|
|
78
|
+
| `TARGET_PORT` | The port that your Puma server should run on. Thruster will set `PORT` to this value when starting your server. | 3000 |
|
|
79
|
+
| `CACHE_SIZE` | The size of the HTTP cache in bytes. | 64MB |
|
|
80
|
+
| `MAX_CACHE_ITEM_SIZE` | The maximum size of a single item in the HTTP cache in bytes. | 1MB |
|
|
81
|
+
| `X_SENDFILE_ENABLED` | Whether to enable X-Sendfile support. Set to `0` or `false` to disable. | Enabled |
|
|
82
|
+
| `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` |
|
|
83
|
+
| `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` |
|
|
84
84
|
| `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` |
|
|
85
|
-
| `HTTP_PORT` | The port to listen on for HTTP traffic.
|
|
86
|
-
| `HTTPS_PORT` | The port to listen on for HTTPS traffic.
|
|
87
|
-
| `HTTP_IDLE_TIMEOUT` | The maximum time in seconds that a client can be idle before the connection is closed.
|
|
88
|
-
| `HTTP_READ_TIMEOUT` | The maximum time in seconds that a client can take to send the request headers.
|
|
89
|
-
| `HTTP_WRITE_TIMEOUT` | The maximum time in seconds during which the client must read the response.
|
|
90
|
-
| `ACME_DIRECTORY` | The URL of the ACME directory to use for
|
|
91
|
-
| `EAB_KID` | The EAB key identifier to use when provisioning
|
|
92
|
-
| `EAB_HMAC_KEY` | The Base64-encoded EAB HMAC key to use when provisioning
|
|
93
|
-
| `DEBUG` | Set to `1` or `true` to enable debug logging.
|
|
85
|
+
| `HTTP_PORT` | The port to listen on for HTTP traffic. | 80 |
|
|
86
|
+
| `HTTPS_PORT` | The port to listen on for HTTPS traffic. | 443 |
|
|
87
|
+
| `HTTP_IDLE_TIMEOUT` | The maximum time in seconds that a client can be idle before the connection is closed. | 60 |
|
|
88
|
+
| `HTTP_READ_TIMEOUT` | The maximum time in seconds that a client can take to send the request headers and body. | 30 |
|
|
89
|
+
| `HTTP_WRITE_TIMEOUT` | The maximum time in seconds during which the client must read the response. | 30 |
|
|
90
|
+
| `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) |
|
|
91
|
+
| `EAB_KID` | The EAB key identifier to use when provisioning TLS certificates, if required. | None |
|
|
92
|
+
| `EAB_HMAC_KEY` | The Base64-encoded EAB HMAC key to use when provisioning TLS certificates, if required. | None |
|
|
93
|
+
| `DEBUG` | Set to `1` or `true` to enable debug logging. | Disabled |
|
|
94
94
|
|
|
95
95
|
To prevent naming clashes with your application's own environment variables,
|
|
96
96
|
Thruster's environment variables can optionally be prefixed with `THRUSTER_`.
|
|
97
|
-
For example, `
|
|
97
|
+
For example, `TLS_DOMAIN` can also be written as `THRUSTER_TLS_DOMAIN`. Whenever
|
|
98
98
|
a prefixed variable is set, it will take precedence over the unprefixed version.
|
data/lib/thruster/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: thruster
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Kevin McConnell
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2024-
|
|
11
|
+
date: 2024-07-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: A zero-config HTTP/2 proxy for lightweight production deployments
|
|
14
14
|
email: kevin@37signals.com
|