.. Telescope Looking Glass Proxy documentation master file, created by
   sphinx-quickstart on Fri Apr 15 15:22:00 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the LGProxy Documentation!
=====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Introduction
************

LGProxy is a high-performance proxy for the Looking Glass application. It
utilizes the Telescope Remote Framebuffer Library for transport over both
commodity and RDMA capable networking hardware.


View our `GitHub repository <https://github.com/telescope-proj/lgproxy>`_.

Developed by the :doc:`team/team`.

.. image:: diagram.png

Table of Contents
=================

* :ref:`genindex`

.. toctree::
   :caption: Getting Started

   user/requirements
   user/installation
   user/building
   user/running
   user/runlg

.. toctree::
   :caption: Bug Reports

   bugs/format
   bugs/knownbugs

.. toctree::
   :caption: Developers

   team/team

.. toctree::
   :caption: API Documentation

   api/index

.. toctree::
   :caption: Licensing

   user/copyright