docs: update docs post 1.3.2 release

saucelabs · Aug 5, 2024 · 589284c · 589284c
1 parent 926558a
commit 589284c
Show file tree

Hide file tree

Showing 12 changed files with 91 additions and 93 deletions.
diff --git a/docs/content/cli/forwarder_pac_eval.md b/docs/content/cli/forwarder_pac_eval.md
@@ -127,6 +127,15 @@ Zero means no limit.
 The maximum amount of time waiting to wait for a TLS handshake.
 Zero means no limit.
 
+### `--http-tls-keylog-file` {#http-tls-keylog-file}
+
+* Environment variable: `FORWARDER_HTTP_TLS_KEYLOG_FILE`
+* Value Format: `<path>`
+
+File to log TLS master secrets in NSS key log format.
+By default, the value is taken from the SSLKEYLOGFILE environment variable.
+It can be used to allow external programs such as Wireshark to decrypt TLS connections.
+
 ### `--insecure` {#insecure}
 
 * Environment variable: `FORWARDER_INSECURE`

diff --git a/docs/content/cli/forwarder_pac_server.md b/docs/content/cli/forwarder_pac_server.md
@@ -213,6 +213,15 @@ Zero means no limit.
 The maximum amount of time waiting to wait for a TLS handshake.
 Zero means no limit.
 
+### `--http-tls-keylog-file` {#http-tls-keylog-file}
+
+* Environment variable: `FORWARDER_HTTP_TLS_KEYLOG_FILE`
+* Value Format: `<path>`
+
+File to log TLS master secrets in NSS key log format.
+By default, the value is taken from the SSLKEYLOGFILE environment variable.
+It can be used to allow external programs such as Wireshark to decrypt TLS connections.
+
 ### `--insecure` {#insecure}
 
 * Environment variable: `FORWARDER_INSECURE`
@@ -230,6 +239,7 @@ Enable to work with self-signed certificates.
 * Value Format: `<path>`
 
 Path to the log file, if empty, logs to stdout.
+The file is reopened on SIGHUP to allow log rotation using external tools.
 
 ### `--log-http` {#log-http}
 

diff --git a/docs/content/cli/forwarder_run.md b/docs/content/cli/forwarder_run.md
@@ -393,6 +393,15 @@ Zero means no limit.
 The maximum amount of time waiting to wait for a TLS handshake.
 Zero means no limit.
 
+### `--http-tls-keylog-file` {#http-tls-keylog-file}
+
+* Environment variable: `FORWARDER_HTTP_TLS_KEYLOG_FILE`
+* Value Format: `<path>`
+
+File to log TLS master secrets in NSS key log format.
+By default, the value is taken from the SSLKEYLOGFILE environment variable.
+It can be used to allow external programs such as Wireshark to decrypt TLS connections.
+
 ### `--insecure` {#insecure}
 
 * Environment variable: `FORWARDER_INSECURE`
@@ -444,6 +453,7 @@ The amount of time allowed to read request headers.
 * Value Format: `<path>`
 
 Path to the log file, if empty, logs to stdout.
+The file is reopened on SIGHUP to allow log rotation using external tools.
 
 ### `--log-http` {#log-http}
 

diff --git a/docs/content/cli/forwarder_test_grpc.md b/docs/content/cli/forwarder_test_grpc.md
@@ -74,6 +74,7 @@ Syntax:
 * Value Format: `<path>`
 
 Path to the log file, if empty, logs to stdout.
+The file is reopened on SIGHUP to allow log rotation using external tools.
 
 ### `--log-level` {#log-level}
 

diff --git a/docs/content/cli/forwarder_test_httpbin.md b/docs/content/cli/forwarder_test_httpbin.md
@@ -89,40 +89,6 @@ Syntax:
 - File: `/path/to/file.pac`
 - Embed: `data:base64,<base64 encoded data>`
 
-## API server options
-
-### `--api-address` {#api-address}
-
-* Environment variable: `FORWARDER_API_ADDRESS`
-* Value Format: `<host:port>`
-* Default value: `localhost:10000`
-
-The server address to listen on.
-If the host is empty, the server will listen on all available interfaces.
-
-### `--api-basic-auth` {#api-basic-auth}
-
-* Environment variable: `FORWARDER_API_BASIC_AUTH`
-* Value Format: `<username[:password]>`
-
-Basic authentication credentials to protect the server.
-
-### `--api-idle-timeout` {#api-idle-timeout}
-
-* Environment variable: `FORWARDER_API_IDLE_TIMEOUT`
-* Value Format: `<duration>`
-* Default value: `1h0m0s`
-
-The maximum amount of time to wait for the next request before closing connection.
-
-### `--api-read-header-timeout` {#api-read-header-timeout}
-
-* Environment variable: `FORWARDER_API_READ_HEADER_TIMEOUT`
-* Value Format: `<duration>`
-* Default value: `1m0s`
-
-The amount of time allowed to read request headers.
-
 ## Logging options
 
 ### `--log-file` {#log-file}
@@ -131,11 +97,12 @@ The amount of time allowed to read request headers.
 * Value Format: `<path>`
 
 Path to the log file, if empty, logs to stdout.
+The file is reopened on SIGHUP to allow log rotation using external tools.
 
 ### `--log-http` {#log-http}
 
 * Environment variable: `FORWARDER_LOG_HTTP`
-* Value Format: `[api|server:]<none|short-url|url|headers|body|errors>,...`
+* Value Format: `<none|short-url|url|headers|body|errors>,...`
 * Default value: `errors`
 
 HTTP request and response logging mode.

diff --git a/docs/content/config/forwarder_pac_eval.yaml b/docs/content/config/forwarder_pac_eval.yaml
@@ -72,6 +72,13 @@
 # limit.
 #http-tls-handshake-timeout: 10s
 
+# http-tls-keylog-file <path>
+#
+# File to log TLS master secrets in NSS key log format. By default, the value is
+# taken from the SSLKEYLOGFILE environment variable. It can be used to allow
+# external programs such as Wireshark to decrypt TLS connections.
+#http-tls-keylog-file: 
+
 # insecure <value>
 #
 # Don't verify the server's certificate chain and host name. Enable to work with

diff --git a/docs/content/config/forwarder_pac_server.yaml b/docs/content/config/forwarder_pac_server.yaml
@@ -126,6 +126,13 @@
 # limit.
 #http-tls-handshake-timeout: 10s
 
+# http-tls-keylog-file <path>
+#
+# File to log TLS master secrets in NSS key log format. By default, the value is
+# taken from the SSLKEYLOGFILE environment variable. It can be used to allow
+# external programs such as Wireshark to decrypt TLS connections.
+#http-tls-keylog-file: 
+
 # insecure <value>
 #
 # Don't verify the server's certificate chain and host name. Enable to work with
@@ -136,7 +143,8 @@
 
 # log-file <path>
 #
-# Path to the log file, if empty, logs to stdout.
+# Path to the log file, if empty, logs to stdout. The file is reopened on SIGHUP
+# to allow log rotation using external tools.
 #log-file: 
 
 # log-http <none|short-url|url|headers|body|errors>,... 

diff --git a/docs/content/config/forwarder_run.yaml b/docs/content/config/forwarder_run.yaml
@@ -263,6 +263,13 @@
 # limit.
 #http-tls-handshake-timeout: 10s
 
+# http-tls-keylog-file <path>
+#
+# File to log TLS master secrets in NSS key log format. By default, the value is
+# taken from the SSLKEYLOGFILE environment variable. It can be used to allow
+# external programs such as Wireshark to decrypt TLS connections.
+#http-tls-keylog-file: 
+
 # insecure <value>
 #
 # Don't verify the server's certificate chain and host name. Enable to work with
@@ -297,7 +304,8 @@
 
 # log-file <path>
 #
-# Path to the log file, if empty, logs to stdout.
+# Path to the log file, if empty, logs to stdout. The file is reopened on SIGHUP
+# to allow log rotation using external tools.
 #log-file: 
 
 # log-http [api|proxy:]<none|short-url|url|headers|body|errors>,... 

diff --git a/docs/content/config/forwarder_test_grpc.yaml b/docs/content/config/forwarder_test_grpc.yaml
@@ -39,7 +39,8 @@
 
 # log-file <path>
 #
-# Path to the log file, if empty, logs to stdout.
+# Path to the log file, if empty, logs to stdout. The file is reopened on SIGHUP
+# to allow log rotation using external tools.
 #log-file: 
 
 # log-level <error|info|debug>

diff --git a/docs/content/config/forwarder_test_httpbin.yaml b/docs/content/config/forwarder_test_httpbin.yaml
@@ -52,38 +52,15 @@
 # - Embed: data:base64,<base64 encoded data>
 #tls-key-file: 
 
-# --- API server options ---
-
-# api-address <host:port>
-#
-# The server address to listen on. If the host is empty, the server will listen
-# on all available interfaces.
-#api-address: localhost:10000
-
-# api-basic-auth <username[:password]>
-#
-# Basic authentication credentials to protect the server.
-#api-basic-auth: 
-
-# api-idle-timeout <duration>
-#
-# The maximum amount of time to wait for the next request before closing
-# connection.
-#api-idle-timeout: 1h0m0s
-
-# api-read-header-timeout <duration>
-#
-# The amount of time allowed to read request headers.
-#api-read-header-timeout: 1m0s
-
 # --- Logging options ---
 
 # log-file <path>
 #
-# Path to the log file, if empty, logs to stdout.
+# Path to the log file, if empty, logs to stdout. The file is reopened on SIGHUP
+# to allow log rotation using external tools.
 #log-file: 
 
-# log-http [api|server:]<none|short-url|url|headers|body|errors>,... 
+# log-http <none|short-url|url|headers|body|errors>,... 
 #
 # HTTP request and response logging mode. 
 # 

diff --git a/docs/data/assets.yml b/docs/data/assets.yml
@@ -1,36 +1,36 @@
 - os: macOS
   arch: all
-  name: forwarder-1.3.1_darwin-signed.all.zip
-  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_darwin-signed.all.zip
+  name: forwarder-1.3.2_darwin-signed.all.zip
+  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_darwin-signed.all.zip
 - os: Debian/Ubuntu
   arch: ARM64
-  name: forwarder_1.3.1.linux_arm64.deb
-  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder_1.3.1.linux_arm64.deb
+  name: forwarder_1.3.2.linux_arm64.deb
+  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder_1.3.2.linux_arm64.deb
 - os: Debian/Ubuntu
   arch: x86-64
-  name: forwarder_1.3.1.linux_amd64.deb
-  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder_1.3.1.linux_amd64.deb
+  name: forwarder_1.3.2.linux_amd64.deb
+  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder_1.3.2.linux_amd64.deb
 - os: RedHat/CentOS/Fedora
   arch: ARM64
-  name: forwarder-1.3.1_linux.aarch64.rpm
-  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_linux.aarch64.rpm
+  name: forwarder-1.3.2_linux.aarch64.rpm
+  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_linux.aarch64.rpm
 - os: RedHat/CentOS/Fedora
   arch: x86-64
-  name: forwarder-1.3.1_linux.x86_64.rpm
-  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_linux.x86_64.rpm
+  name: forwarder-1.3.2_linux.x86_64.rpm
+  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_linux.x86_64.rpm
 - os: Linux
   arch: ARM64
-  name: forwarder-1.3.1_linux.aarch64.tar.gz
-  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_linux.aarch64.tar.gz
+  name: forwarder-1.3.2_linux.aarch64.tar.gz
+  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_linux.aarch64.tar.gz
 - os: Linux
   arch: x86-64
-  name: forwarder-1.3.1_linux.x86_64.tar.gz
-  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_linux.x86_64.tar.gz
+  name: forwarder-1.3.2_linux.x86_64.tar.gz
+  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_linux.x86_64.tar.gz
 - os: Windows
   arch: ARM64
-  name: forwarder-1.3.1_windows.aarch64.zip
-  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_windows.aarch64.zip
+  name: forwarder-1.3.2_windows.aarch64.zip
+  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_windows.aarch64.zip
 - os: Windows
   arch: x86-64
-  name: forwarder-1.3.1_windows.x86_64.zip
-  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_windows.x86_64.zip
+  name: forwarder-1.3.2_windows.x86_64.zip
+  url: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_windows.x86_64.zip
diff --git a/docs/data/latest.yml b/docs/data/latest.yml
@@ -1,11 +1,11 @@
-checksums: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/checksums
-darwin-signed.all.zip: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_darwin-signed.all.zip
-darwin.all.zip: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_darwin.all.zip
-linux.aarch64.rpm: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_linux.aarch64.rpm
-linux.aarch64.tar.gz: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_linux.aarch64.tar.gz
-linux.x86_64.rpm: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_linux.x86_64.rpm
-linux.x86_64.tar.gz: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_linux.x86_64.tar.gz
-windows.aarch64.zip: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_windows.aarch64.zip
-windows.x86_64.zip: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder-1.3.1_windows.x86_64.zip
-linux_amd64.deb: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder_1.3.1.linux_amd64.deb
-linux_arm64.deb: https://github.com/saucelabs/forwarder/releases/download/v1.3.1/forwarder_1.3.1.linux_arm64.deb
+checksums: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/checksums
+darwin-signed.all.zip: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_darwin-signed.all.zip
+darwin.all.zip: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_darwin.all.zip
+linux.aarch64.rpm: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_linux.aarch64.rpm
+linux.aarch64.tar.gz: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_linux.aarch64.tar.gz
+linux.x86_64.rpm: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_linux.x86_64.rpm
+linux.x86_64.tar.gz: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_linux.x86_64.tar.gz
+windows.aarch64.zip: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_windows.aarch64.zip
+windows.x86_64.zip: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder-1.3.2_windows.x86_64.zip
+linux_amd64.deb: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder_1.3.2.linux_amd64.deb
+linux_arm64.deb: https://github.com/saucelabs/forwarder/releases/download/v1.3.2/forwarder_1.3.2.linux_arm64.deb