thruster 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -13
  3. data/lib/thruster/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d438ef01590c14b4b6f062b8d1cc6de3d17738675b057b7c28845315e0c6eac3
4
- data.tar.gz: a6f59f85f822248ed0d1feae910b8a1533d1b72fd5bacc0a5b529b126083fd01
3
+ metadata.gz: 5d824c41e06ae439c2b1b7836e98ce4a54cdb897330e7fd9b21d7347a9939cf2
4
+ data.tar.gz: 89ab69be6185e378dbc9be116fd2204d88076d3f253aa4556a07b4a55d8d7b4e
5
5
  SHA512:
6
- metadata.gz: eacedcaaef76ca6c0f42639adbe76d8044c4717d3f1afde6ead6874aa77c393af1c2e6f608fb0a1b7d7f6c861b38b047f71ee1d13131927c4ef2ae9ad22b8c60
7
- data.tar.gz: e32326371efbb53c9678b0737a9e454cc7afd65f8fdc2b7685f161033cdbf035d7ff3b64442716fea1c5c2a5aebb452192580052567ecda2bac99f8391134bb3
6
+ metadata.gz: b052e97b380103576591d2e5ffcdf4abf2592de072683d76c30c7346a8b367466445db074e18522a4f33762a9e3a58444ce06afe13a062b0b6756ebcdb060e0b
7
+ data.tar.gz: 33a2010bd3378f5bbc375c0a18c2e028e28724de1d5bf1520fe781850620d58edafb949c33a46d3f1a4996a50355fb770f12597b8d1d9fc1f6975aa91e342266
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 SSL certificate management with Let's Encrypt
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 SSL provisioning: in order for Thruster to
18
- provision SSL certificates, it needs to know which domain those certificates
19
- should be for. So to use SSL, you need to set the `SSL_DOMAIN` environment
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 SSL:
62
+ Or with automatic TLS:
63
63
 
64
64
  ```sh
65
- $ SSL_DOMAIN=myapp.example.com thrust bin/rails server
65
+ $ TLS_DOMAIN=myapp.example.com thrust bin/rails server
66
66
  ```
67
67
 
68
68
 
@@ -74,25 +74,25 @@ environment variables that you can set.
74
74
 
75
75
  | Variable Name | Description | Default Value |
76
76
  |-----------------------|---------------------------------------------------------------------------------|---------------|
77
- | `SSL_DOMAIN` | The domain name to use for SSL provisioning. If not set, SSL will be disabled. | None |
77
+ | `TLS_DOMAIN` | The domain name to use for TLS provisioning. If not set, TLS will be disabled. | None |
78
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
79
  | `CACHE_SIZE` | The size of the HTTP cache in bytes. | 64MB |
80
80
  | `MAX_CACHE_ITEM_SIZE` | The maximum size of a single item in the HTTP cache in bytes. | 1MB |
81
81
  | `X_SENDFILE_ENABLED` | Whether to enable X-Sendfile support. Set to `0` or `false` to disable. | Enabled |
82
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 SSL certificates will be stored here, so that they will not need to be requested every time your application is started. | `./storage/thruster` |
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
85
  | `HTTP_PORT` | The port to listen on for HTTP traffic. | 80 |
86
86
  | `HTTPS_PORT` | The port to listen on for HTTPS traffic. | 443 |
87
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. | 30 |
88
+ | `HTTP_READ_TIMEOUT` | The maximum time in seconds that a client can take to send the request headers and body. | 30 |
89
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 SSL certificate provisioning. | `https://acme-v02.api.letsencrypt.org/directory` (Let's Encrypt production) |
91
- | `EAB_KID` | The EAB key identifier to use when provisioning SSL certificates, if required. | None |
92
- | `EAB_HMAC_KEY` | The Base64-encoded EAB HMAC key to use when provisioning SSL certificates, if required. | None |
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
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, `SSL_DOMAIN` can also be written as `THRUSTER_SSL_DOMAIN`. Whenever
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
@@ -1,3 +1,3 @@
1
1
  module Thruster
2
- VERSION = "0.1.3"
2
+ VERSION = "0.1.4"
3
3
  end
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.3
4
+ version: 0.1.4
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-03-21 00:00:00.000000000 Z
11
+ date: 2024-04-26 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