Skip to content

Erics tls updatesUpdated TLS doc configuration options table to match v4.1 release. Fixes #2088. #2123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Oct 29, 2025
Merged

Erics tls updatesUpdated TLS doc configuration options table to match v4.1 release. Fixes #2088. #2123

Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5f4a90c
Removing a readme file this is not standardized in classic-mode direc…
eschabell Oct 22, 2025
ca437dc
Updated to not use readme file in classic-config directory, but the c…
eschabell Oct 22, 2025
5bbc956
Updated to better sort some sections and update for missing entries. …
eschabell Oct 22, 2025
b630391
Merge branch 'fluent:master' into master
eschabell Oct 23, 2025
e4ea1cc
Updated configuration variables for opentelemetry output plugin, many…
eschabell Oct 23, 2025
f8ff78d
Updated configuration variables for opentelemetry output plugin, many…
eschabell Oct 23, 2025
8b007c0
Fixes reqeusted by reviewers for options table for opentelemetry outp…
eschabell Oct 24, 2025
8f2b2a1
Merge branch 'fluent:master' into master
eschabell Oct 27, 2025
81143f7
Merge branch 'fluent:master' into master
eschabell Oct 27, 2025
f93136a
Merge branch 'fluent:master' into master
eschabell Oct 28, 2025
64f3299
Updated TLS doc configuration options table to match v4.1 release. Fi…
eschabell Oct 28, 2025
a7f4d6b
Updates to fix suggestion from @esmerel. Applys to #2088.
eschabell Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 22 additions & 19 deletions administration/transport-security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,21 @@ Fluent Bit provides integrated support for Transport Layer Security (TLS) and it

Both input and output plugins that perform Network I/O can optionally enable TLS and configure the behavior. The following table describes the properties available:

| Property | Description | Default |
| :--- | :--- | :--- |
| `tls` | Enable or disable TLS support. | `Off` |
| `tls.verify` | Force certificate validation. | `On` |
| `tls.verify_hostname` | Force TLS verification of host names. | `Off` |
| `tls.debug` | Set TLS debug verbosity level. Accepted values: `0` (No debug), `1` (Error), `2` (State change), `3` (Informational) and `4`. (Verbose) | `1` |
| `tls.ca_file` | Absolute path to CA certificate file. | _none_ |
| `tls.ca_path` | Absolute path to scan for certificate files. | _none_ |
| `tls.crt_file` | Absolute path to Certificate file. | _none_ |
| `tls.key_file` | Absolute path to private Key file. | _none_ |
| `tls.key_passwd` | Optional password for `tls.key_file` file. | _none_ |
| `tls.vhost` | Hostname to be used for TLS SNI extension. | _none_ |
| Property | Description | Default |
|:----------------------|:----------------------------------------------------------------------------------------------------------------------------------------|:--------|
| `tls` | Enable or disable TLS support. | `off` |
| `tls.debug` | Set TLS debug verbosity level. Accepted values: `0` (No debug), `1` (Error), `2` (State change), `3` (Informational) and `4`. (Verbose) | `1` |
| `tls.ca_file` | Absolute path to CA certificate file. | _none_ |
| `tls.ca_path` | Absolute path to scan for certificate files. | _none_ |
| `tls.ciphers` | Specify TLS ciphers up to TLSv1.2. | _none_ |
| `tls.crt_file` | Absolute path to Certificate file. | _none_ |
| `tls.key_file` | Absolute path to private Key file. | _none_ |
| `tls.key_passwd` | Optional password for `tls.key_file` file. | _none_ |
| `tls.max_version` | Specify the maximum version of TLS. | _none_ |
| `tls.min_version` | Specify the minimum version of TLS. | _none_ |
| `tls.verify` | Force certificate validation. | `on` |
| `tls.vhost` | Hostname to be used for TLS SNI extension. | _none_ |
| `tls.verify_hostname` | Force TLS verification of host names. | `off` |

To use TLS on input plugins, you must provide both a certificate and a private key.

Expand Down Expand Up @@ -187,8 +190,8 @@ pipeline:
Host 192.168.2.3
Port 80
URI /something
tls On
tls.verify Off
tls on
tls.verify off
```

{% endtab %}
Expand Down Expand Up @@ -247,8 +250,8 @@ pipeline:
Match *
Host 192.168.10.100
Port 24224
tls On
tls.verify On
tls on
tls.verify on
tls.ca_file /etc/certs/fluent.crt
tls.vhost fluent.example.com
```
Expand Down Expand Up @@ -302,8 +305,8 @@ pipeline:
Match *
Host other.fluent-aggregator.net
Port 24224
tls On
tls.verify On
tls on
tls.verify on
tls.verify_hostname on
tls.ca_file /path/to/fluent-x509v3-alt-name.crt
```
Expand All @@ -317,4 +320,4 @@ This outgoing connect will fail and disconnect:
[2024/06/17 16:51:31] [error] [tls] error: unexpected EOF with reason: certificate verify failed
[2024/06/17 16:51:31] [debug] [upstream] connection #50 failed to other.fluent-aggregator.net:24224
[2024/06/17 16:51:31] [error] [output:forward:forward.0] no upstream connections available
```
```