Skip to content

Revamp Glutton documentation to include latest updates and drive adoption #191

@furusiyya

Description

@furusiyya

Update the Glutton introduction to cover how it is unique in the realm of other honeypots and where it fits best in the overall deception environment. Also cover its architecture and Spicy integration.

The most important part would be the Extension system, specifically how it can be extended to include protocol handlers and effectively use Spicy-based parsers to digest payloads and produce more riches logs/events.

It would also be useful to add a contributor's guide covering how to contribute, code practices, and tests, along with somewhere to surface the next priorities (a high-level roadmap). An FAQ section would help too.

Also, in some places the docs drift from the actual implementation (e.g., Go versions, SSH default port, logging style), so review and fix them.
Adding visual assets like Discord, version, and license badges would also improve engagement.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions