thinkst / opencanary

Modular and decentralised honeypot
http://opencanary.org
BSD 3-Clause "New" or "Revised" License
2.21k stars 353 forks source link

Document device.listen_addr and Handling Twisted Web Logs #349

Closed nbuuckssi closed 3 months ago

nbuuckssi commented 3 months ago

Proposed changes

This PR documents what I learned about Twisted HTTP logs that continued to appear in my host's syslog despite removing the default Syslog and Console handler's from my OpenCanary installation's configuration. This duplication of HTTP logs was undesirable because another security tool was capturing both the syslog and the JSON logged by my OpenCanary configuration to a rotating file in /var/log.

This PR also documents the seemingly-undocumented device.listen_addr configuration option added in #337.

Types of changes

What types of changes does your code introduce to this repository? Put an x in the boxes that apply

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

nbuuckssi commented 3 months ago

I suppose it's worth considering whether device.listen_addr should just be added to the default configuration file in lieu of adding the table presently in this PR. The table has the advantage of being able to explain the caveat that it only applies to certain modules.