Welcome to heiDGAF's documentation!
===================================

**heiDGAF** is a machine learning-based DNS classifier for detecting Domain Generation Algorithms (DGAs), tunneling, and
data exfiltration by malicious actors.

Check out the :doc:`usage` section for further information on how to use the software, including how to
:ref:`install <installation>` and :ref:`configure <configuration>` the project. For more details on the implementation
and structure, take a look at the :doc:`pipeline` section. The :doc:`monitoring` section describes how to set up the
monitoring environment for observing the software's functionality in real-time.

.. note::

   This project is under active development.


Contents
--------

.. toctree::
   :maxdepth: 2

   usage
   pipeline
   monitoring
   training
   developer_guide
   api/index
   references