CONTRIBUTING.md

How to contribute to Security Onion

First, thanks for being a part of the Security Onion community! We appreciate any and all contributions!

Mailing List

The biggest thing that we need help with right now is supporting users on the security-onion group. Please see the group guidelines.

QA

We ask for testing before we release updates. Please join our security-onion-testing group and help us avoid regressions!

Did you find a bug?

• Do not open up a GitHub issue if the bug is a security vulnerability in Security Onion, and instead refer to https://securityonion.net/docs/Security.

• Ensure the bug was not already reported by searching on GitHub under Issues.

• If you're unable to find an open issue addressing the problem, send a detailed email to the security-onion group. We'll triage the issue and then open a Github Issue if necessary.

Want to help us work on issues?

• Take a look at the unassigned issues at https://github.com/Security-Onion-Solutions/security-onion/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+no%3Aassignee and see if there are issues you are interested in tackling. Please keep in mind that some of these issues may be older and thus no longer accurate or applicable. When in doubt, please feel free to reach out to the security-onion group for clarification and guidance.

Are you looking for source code?

• You can get the source for any of our packages by doing the following at a terminal (replacing PACKAGE-NAME with the name of the package that you want the source for):

apt-get source PACKAGE-NAME

Some of our packages have their own Github repos at Security-Onion-Solutions.

Packages are built and hosted at https://launchpad.net/~securityonion/+archive/ubuntu/stable. For more about the Launchpad build process, please see https://help.launchpad.net/Packaging/PPA.

Docker images can be found at https://hub.docker.com/u/securityonionsolutions/. Dockerfiles used to build those Docker images can be found at https://github.com/Security-Onion-Solutions/securityonion-docker.

Do you want to contribute to the Security Onion documentation?

• If you want to add or make changes to the documentation, please see https://securityonion.readthedocs.io/en/latest/about.html#contributing.

Thanks! ❤️ ❤️ ❤️

Security Onion Team