Welcome

Thanks for checking out ThreatPipes.

This documentation covers how to install, use, and enhance ThreatPipes. It is the first place to start if you have any questions.

Table of contents

• Home

Admin Guide

• Installing ThreatPipes
• Securing ThreatPipes
• Starting ThreatPipes
• Configuring ThreatPipes
• Troubleshooting ThreatPipes

User Guide

• Introduction to Modules
• Starting a Scan
• Working with Scan Result

API Guide

• Getting Started

Developer Guide

• Developing New Modules
• Developing New Correlation Rules

Get a copy of this documentation locally

You can copy this documentation locally:

git clone https://gitlab.com/threatpipes/threatpipes-docs

...and build it using gitbook

TODO

Still have questions?

• Community Slack: Open to anyone. Community support offered. Staffed by the ThreatPipes team.
• Email: If you have purchased a ThreatPipes licence with email support you can submit a ticket directly to the ThreatPipes Support Team.