Skip to content

Latest commit

 

History

History
107 lines (76 loc) · 4.55 KB

CONTRIBUTING.md

File metadata and controls

107 lines (76 loc) · 4.55 KB
Raw

Contributing to Moloch

✨ Glad to see you here! ✨

Just have a question ❓

Where do I start? 🚥

First, checkout the main Moloch README for information on how to build and run Moloch.

Then, get some test data!

  • Make sure node 10 is in your path
  • Install and Start Elasticsearch
  • Use easybutton-build.sh or configure and make to build everything
  • Run make check from the top level directory, this will
    • run npm ci everywhere
    • run tests.pl and tests.pl --viewer in the tests directory

Note: this will only work if viewer is not already running.

You should now have test data loaded, so let's start the web app:

  • Move to the Moloch viewer directory
  • Run npm ci
  • Move to the vueapp directory
  • Run npm ci
  • Move back up to the viewer directory
  • Run npm run start:test
  • Now browse to the app at http://localhost:8123

🕐 On first load, you will likely see this message: "No results or none that match your search within your time range." This is because the data that was loaded is from all time ranges, so make sure you search for ALL times ranges.

For more information about running the Moloch Viewer web application, visit the viewer README.

How do I contribute?

Documentation! 📃

Documentation, READMEs, examples, and FAQs are important. Please help improve and add to them.

Bugs 🐛 🪲 🐜

Before submitting a bug report:

  • Ensure the bug was not already reported by searching for existing issues in Moloch
    • If an issues is already open, make a comment that you are experiencing the same thing and provide any additional details
  • Check the FAQs for a list of common questions and problems

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

  • Provide a clear and descriptive title
  • Describe the exact steps to reproduce the problem
  • Explain the expected behavior
  • Fill out the issue template completely

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:

  • Provide a clear and descriptive title
  • Describe the suggested feature in as much detail as possible
  • Use examples to help us understand the use case of the feature
  • If you are requesting a minor improvement, describe the current behavior and why it is not sufficient
  • If possible, provide examples of where this feature exists elsewhere in other tools
  • Follow the directions in the issue template

Pull Requests 💪

We welcome all collaboration! If you can fix it or implement it, please do! 🔨

To better help us review your pull request, please follow these guidelines:

  • Provide a clear and descriptive title
  • Clearly describe the problem and solution
  • Include the relevant issue number(s) if applicable
  • If changes are made to the capture component, verify all tests in the tests direction pass by running ./tests.pl
  • Run npm run lint from the top level directory and correct any errors
  • Additionally, for any viewer or parliament changes, verify that all UI tests pass by runnning ./tests.pl --viewer
  • The README file in the tests directory provides additional information on the test cases

Upgrading Cyberchef

  1. Update the CyberChef version ("CYBERCHEFVERSION") in viewer/viewer.js
  2. Update the CyberChef version in viewer/Makefile.in (there are two version numbers on line 23)
  3. Run make in viewer or download the new version of the CyberChef zip file manually to the viewer/public directory
  4. Unzip and copy CyberChef_v*.html to viewer/public/CyberChef_v*.html
  5. Add <base href="./cyberchef/" /> in the <head> of viewer/public/CyberChef_v*.html
  6. Add the script section from the previous viewer/public/cyberchef.html file before the end </body></html> tags at the end of viewer/public/CyberChef_v*.html
  7. Delete the old CyberChef zip file
  8. Delete the old CyberChef html file
  9. Rename viewer/public/CyberChef_v*.html file to viewer/public/cyberchef.html

❤️ Thanks,

Andy & Elyse