Skip to content

docs: Update docs for syslog TCP server TLS configuration options #67

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Update docs for syslog TCP server TLS configuration options #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2b0a81
docs: Updated docs for TLS options for syslog TCP server (#1)
technusm1 Jun 7, 2025
28d91c7
Merge branch 'openobserve:main' into main
technusm1 Jun 7, 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
4 changes: 4 additions & 0 deletions docs/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ OpenObserve is configured through the use of below environment variables.
| ZO_ALERT_SCHEDULE_INTERVAL | | No | |
| ZO_TCP_PORT | 5514 | No | TCP port for syslog |
| ZO_UDP_PORT | 5514 | No | UDP port for syslog |
| ZO_TCP_TLS_ENABLED | false | No | Enable TLS for TCP syslog server. |
| ZO_TCP_TLS_CERT_PATH | | No | Path to the TLS certificate file to be used on the server. |
| ZO_TCP_TLS_KEY_PATH | | No | Path to the TLS key file to be used on the server. |
| ZO_TCP_TLS_CA_CERT_PATH | | No | Path to the TLS CA certificate file to be used on the server. |
| ZO_APP_NAME | | No | |
| ZO_DEFAULT_SCRAPE_INTERVAL | | No | |
| ZO_CIRCUIT_BREAKER_ENABLE | | No | |
Expand Down
8 changes: 8 additions & 0 deletions docs/ingestion/logs/syslog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ You can change the default port number using the following environment variables
* `ZO_TCP_PORT` - TCP port number to listen on. Default: `5514`
* `ZO_UDP_PORT` - UDP port number to listen on. Default: `5514`

You can also configure the TLS settings for syslog TCP server using the following environment variables:
* `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`

If `ZO_TCP_TLS_ENABLED` is set to `true`, then make sure to set all the below variables in production:
* `ZO_TCP_TLS_CERT_PATH` - Path to the TLS certificate file to be used on the server.
* `ZO_TCP_TLS_KEY_PATH` - Path to the TLS key file to be used on the server.
* `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.


## Testing

Expand Down