Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 2.46 KB

Contributing to pfELK


Questions ❓

  • Visit our FAQs <<<-coming soon->>>
  • <<>>

Start Here

First, checkout the pfELK README for information on how to configure and run pfELK.

Then, forward your firewall logs.

  • Make sure you followed all instructions
  • Configured your firewall(s) (pfSense or OPNsense)
  • All required dependencies were installed and/or configured

🕐 For more complex installations please reach out for assistance (i.e. multiple firewalls, sending firewall logs through VPN etc...


How to contribute

Documentation! 📃

Please help improve documentation with your inputs to our READMEs, examples, and FAQs.

Bugs 🪲

Before submitting a bug report:

  • Ensure you are submitting this issue to the correct repository, since we have one for all individual deployments (pfelk, ansible-pfelk, docker-pfelk) listed here: https://github.com/pfelk/pfelk
  • Ensure the bug was not already reported by searching for existing issues in pfELK
    • If an issue is already open, comment to that issue and provide any additional details, to assist.
  • Check the FAQs for common questions and problems <<<-coming soon->>>

Bugs and issues are tracked as GitHub Issues. Please follow these guidelines when submitting a bug request:

  • Ensure the title captures the subject of the issue
  • Describe the exact procedures in replicating the issue(s)
  • Explain the issue(s)
  • Fill out the Bug/Error template

Feature Requests ✨

Feature requests include new features and minor improvements to existing functionality.

Feature requests are tracked as GitHub Issues. Please follow these guidelines when submitting a feature request:

  • Ensure the title captures the subject of the requested feature
  • Describe the feature in as much detail as possible
  • Provide examples to help us understand the requested feature(s)
  • Follow the directions in the feature template

Pull Requests

Collaboration is highly encouraged! Make it better, improve it and share!

Help us with pull requests:

  • Describe the problem and solution
  • Reference and include the issue number(s)
  • Verify any and all changes were extensively tested