.. Bowtie Documentation documentation master file, created by
   sphinx-quickstart on Fri Aug 19 11:38:40 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

#########################
Bowtie User Documentation
#########################

You've arrived at the Bowtie user documentation. Welcome!

These docs are for operators and end-users to aid in working with the Bowtie software. The content you'll find here ranges from getting started to everyday use and maintenance of the application.

.. note:: Please contact our team for feedback, features, and support.

.. _landing-started:

**************
Where To Begin
**************

- If you're here to **secure your network with Bowtie**, you should proceed to :doc:`getting-started`. This will help you install the server-side network appliance and client-side software for connecting to a Bowtie network.

- If you've setup Bowtie and are ready to **connect to an existing Bowtie network**, proceed to :doc:`using-bowtie`.

- If you'd like to **understand the various aspects of the software better** - either to better integrate into your infrastructure or to delve deeper when problem-solving - consider the :doc:`kb` page.

Use the headings links to the left to navigate the top-level documentation topics.
A per-page table of contents will appear on the right side of each page with links that jump to section headings.
If this side bar does not appear on your screen size, use the icon at the upper-right of the browser window to expand the local table of contents.

*****************
Table of Contents
*****************

Use the following table of contents to jump to an area of interest if you know which topic you would like to dive deeper into -- otherwise, we suggest following the path outlined in :ref:`landing-started`.

.. toctree::
   :maxdepth: 2

   getting-started
   using-bowtie
   release-notes
   kb
   troubleshooting
   glossary

.. only:: todo

   Master TODO List
   ^^^^^^^^^^^^^^^^

   The following list of TODO items only appears in non-production builds.
   Use it as a reference for work that remains to be done.

.. todolist::