Skip to content

Commit f2b0a81

Browse files
technusm1technusm1
and
technusm1
authored
docs: Updated docs for TLS options for syslog TCP server (#1)
* Update syslog.md and environment-variables.md with TLS configuration options for syslog TCP server --------- Co-authored-by: technusm1 <maheep.kathuria@gmail.com>
1 parent a724ca5 commit f2b0a81

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/environment-variables.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,10 @@ OpenObserve is configured through the use of below environment variables.
121121
| ZO_ALERT_SCHEDULE_INTERVAL | | No | |
122122
| ZO_TCP_PORT | 5514 | No | TCP port for syslog |
123123
| ZO_UDP_PORT | 5514 | No | UDP port for syslog |
124+
| ZO_TCP_TLS_ENABLED | false | No | Enable TLS for TCP syslog server. |
125+
| ZO_TCP_TLS_CERT_PATH | | No | Path to the TLS certificate file to be used on the server. |
126+
| ZO_TCP_TLS_KEY_PATH | | No | Path to the TLS key file to be used on the server. |
127+
| ZO_TCP_TLS_CA_CERT_PATH | | No | Path to the TLS CA certificate file to be used on the server. |
124128
| ZO_APP_NAME | | No | |
125129
| ZO_DEFAULT_SCRAPE_INTERVAL | | No | |
126130
| ZO_CIRCUIT_BREAKER_ENABLE | | No | |

docs/ingestion/logs/syslog.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ You can change the default port number using the following environment variables
2525
* `ZO_TCP_PORT` - TCP port number to listen on. Default: `5514`
2626
* `ZO_UDP_PORT` - UDP port number to listen on. Default: `5514`
2727

28+
You can also configure the TLS settings for syslog TCP server using the following environment variables:
29+
* `ZO_TCP_TLS_ENABLED` - Enable TLS for TCP syslog server. If enabled, `ZO_TCP_PORT` will be used for the TLS connection over TCP. Default: `false`
30+
31+
If `ZO_TCP_TLS_ENABLED` is set to `true`, then make sure to set all the below variables in production:
32+
* `ZO_TCP_TLS_CERT_PATH` - Path to the TLS certificate file to be used on the server.
33+
* `ZO_TCP_TLS_KEY_PATH` - Path to the TLS key file to be used on the server.
34+
* `ZO_TCP_TLS_CA_CERT_PATH` - Path to the TLS CA certificate file to be used on the server. It is recommended to set this variable if the above 2 variables are set, otherwise, the configured certificate will be treated as a self-signed certificate. This is useful for development and internal testing, but not recommended for production setups as it could still be vulnerable to man-in-the-middle attacks.
35+
2836

2937
## Testing
3038

0 commit comments

Comments
 (0)