.. BICEP documentation master file, created by
   sphinx-quickstart on Wed Mar 26 10:26:36 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to BICEP's documentation!
=================================

**BICEP** is a docker based framework to setup, configure, manage, ensemble, and benchmark IDS and IPS. 
You did not find your desired IDS to deploy and test ? Feel free to add it to the framework via PR! For further information have a look at :ref:`Register new IDS to BICEP <add_new_ids>`

.. note::

   This project is under active development and subject to major changes!


Relevant Repositories
---------------------
- `BICEP <https://github.com/maldwg/BICEP>`_
- `BICEP Utils <https://github.com/maldwg/BICEP_Utils>`_
- `Snort Image Repository <https://github.com/maldwg/BICEP-snort-image>`_
- `Slips Image Repository <https://github.com/maldwg/BICEP-slips-image>`_
- `Suricata Image Repository <https://github.com/maldwg/BICEP-suricata-image>`_

Content
-------

.. toctree::
   :maxdepth: 2

   glossary
   usage/index
   design/index