Skip to content

Commit

Permalink
Trim Whitespace to Fix Pre-Commit Failure (#350)
Browse files Browse the repository at this point in the history
* Update configuration.rst

Adds docs about handling Twisted syslog output and the undocumented `device.listen_addr` configuration option.

* Fix whitespace from #349
  • Loading branch information
nbuuckssi authored Mar 26, 2024
1 parent dfa8c55 commit bcb83f9
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/starting/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ You may want to look through some other python logging options over at `PyLogger

We have provided you with two different formatters. One is the plain message with incident information; the other is the Syslog RFC format. We have already added it to the `syslog-unix` handler for your convenience.

The Twisted Web server `twistd` that OpenCanary uses to provide HTTP services is not affected by these logging options and will log HTTP requests regardless of your configuration, as it is launched with the `--syslog` parameter in `bin/opencanaryd`. This can be undesirable
The Twisted Web server `twistd` that OpenCanary uses to provide HTTP services is not affected by these logging options and will log HTTP requests regardless of your configuration, as it is launched with the `--syslog` parameter in `bin/opencanaryd`. This can be undesirable
in some scenarios like when a SIEM is collecting the syslog *and* a ``RotatingFileHandler`` output by OpenCanary and can be mitigated with an rsyslog config like ``if $programname == 'opencanaryd' and ($msg contains 'GET ' or $msg contains 'POST ') then stop``

Environment Variables
Expand Down

0 comments on commit bcb83f9

Please sign in to comment.