.. STIG Manager documentation master file, created by
   sphinx-quickstart on Sun Feb  7 02:40:25 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to STIG Manager's documentation!
========================================


What is STIG Manager?
-------------------------------
STIG Manager is an Open Source API and Web client for managing the assessment of Information Systems for compliance with `security checklists <https://public.cyber.mil/stigs/>`_ published by the United States (U.S.) Defense Information Systems Agency (DISA). STIG Manager supports DISA checklists `distributed <https://public.cyber.mil/stigs/downloads/>`_ as either a Security Technical Implementation Guide (STIG) or a Security Requirements Guide (SRG) in the XCCDF format.

Our Project incorporates software developed since 2012 by the `U.S. Naval Undersea Warfare Center Division Newport (NUWCDIVNPT) <https://www.navsea.navy.mil/Home/Warfare-Centers/NUWC-Newport/>`_. More information, and the software itself, is available on GitHub: `STIG Manager <https://github.com/NUWCDIVNPT/stig-manager/>`_



.. toctree::
   :maxdepth: 1
   :caption: Contents:

   features/index
   installation-and-setup/index
   user-guide/index
   admin-guide/index
   the-project/index
   the-project/contributing
   reference/index

* :ref:`genindex`


.. toctree::
   :maxdepth: 1
   :caption: Common Tasks:

   features/common-tasks

---------------------


Getting Started with STIG Manager
======================================

.. raw:: html

  <iframe width="560" height="315" src="https://www.youtube.com/embed/wv_Gdbl_LrU" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

------------------------

.. raw:: html

  <iframe width="560" height="315" src="https://www.youtube.com/embed/ZwVJ0eO2d_I" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

-----------------------------------

These videos and others are available on our `YouTube channel. <https://www.youtube.com/channel/UC3kkvP64MRKsTaqcQQ8QA9A>`_

---------------------------

|


Reporting Bugs & Issues
===================================

Please file bug reports or feature requests on the `STIG Manager 
issue tracker <https://github.com/NUWCDIVNPT/stig-manager/issues>`__. When reporting a bug, please provide as much detail as possible to help us understand and reproduce the issue. Include:

-  Install type: Hosted, Local, Docker, etc
-  Detailed steps to reproduce the issue
-  Action taken
-  Expected result
-  Actual result
-  Screenshots or logs (if relevant)
-  Your environment details (OS, browser version, etc.)

Licenses
========================

The  repository is licensed under the `MIT License <https://github.com/NUWCDIVNPT/stig-manager/blob/main/LICENSE.md>`__, with the exception of the client, which is licensed under the `GNU GPL
v3 <https://github.com/NUWCDIVNPT/stig-manager/blob/main/LICENSE.md>`__.