Skip to content

Commit 69ffce4

Browse files
Deprecated pass-unix-credentials() and added so-passcreds() (#106)
Deprecated pass-unix-credentials() and added so-passcreds() Signed-off-by: Zsolt Gyulai (zgyulai) <[email protected]>
2 parents c9512ad + dacd540 commit 69ffce4

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

doc/_admin-guide/090_Global_options/000_Global_options.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -305,18 +305,9 @@ Starting with version 3.16, the default value of this option is -1, so
305305
{{ site.product.short_name }} does not change the ownership, unless explicitly
306306
configured to do so.
307307
308-
## pass-unix-credentials()
308+
## pass-unix-credentials() (DEPRECATED)
309309
310-
| Accepted values:| yes \| no|
311-
|Default:| yes|
312-
313-
*Description:* Enable {{ site.product.short_name }} to collect UNIX credential
314-
information (that is, the `PID`, user ID, and group of the sender process)
315-
for messages received using UNIX domain sockets. Available only in
316-
{{ site.product.name }} 3.7 and later. Note that collecting UNIX
317-
credential information from sockets in high-traffic environments can be
318-
resource intensive, therefore pass-unix-credentials() can be disabled
319-
globally, or separately for each source.
310+
The `pass-unix-credentials()` option has been deprecated in {{ site.product.short_name }} 3.35 and later versions. Use the `so-passcred()` option.
320311
321312
{% include doc/admin-guide/options/perm.md %}
322313
@@ -424,6 +415,15 @@ The following sub-options are available within the stats() option:
424415

425416
**NOTE:** If a lower value is set to stats-max-dynamics() (or, any limiting value, if this option has not been configured before) and {{ site.product.short_name }} is restarted, the changes are only applied after stats-freq() time has passed. That is, the previously allocated dynamic clusters are only removed after this time.
426417

418+
## so-passcred()
419+
420+
|Accepted values:| `yes`, `no`|
421+
|Default: | `yes`|
422+
423+
*Description:* Enable {{ site.product.short_name }} to collect credential
424+
information (that is, the `PID`, user ID, and group of the sender process)
425+
for messages received using UNIX domain sockets.
426+
427427
## syslog-stats()
428428

429429
| Accepted values:| yes, no, auto|

0 commit comments

Comments
 (0)