About This Documentation

Formats

This documentation is published online at https://securityonion.net/docs. If you are viewing an offline version of this documentation but have Internet access, you might want to switch to the online version at https://securityonion.net/docs to see the latest version.

This documentation is also available in PDF format:
https://readthedocs.org/projects/securityonion/downloads/pdf/latest/

Contributing

If you notice any documentation is missing or incorrect, please feel free to submit a pull request (PR) to the following repo:
https://github.com/Security-Onion-Solutions/securityonion-docs

We will review the PR and merge if appropriate.

Naming Convention

Our goal is to allow you to easily guess and type the URL of the documentation you want to go to.

For example, if you want to read more about Suricata, you can type the following into your browser:
https://securityonion.net/docs/suricata

To achieve this goal, new documentation pages should use the following naming convention:

  • all lowercase

  • .rst file extension

  • ideally, the name of the page should be one simple word (for example: suricata.rst)

  • try to avoid symbols such as hyphens and underscores

  • if symbols are required, hyphens are preferred to underscores