.. Panorama by Aulasneo — Operator Manual
   Main index document

.. _home:

Panorama by Aulasneo — Operator Manual
======================================

Welcome to the operator manual for **Panorama**, the multi-LMS learning analytics platform
built by `Aulasneo <https://aulasneo.com>`_. Panorama connects to your learning management
systems and other supporting systems, gathers all the relevant data, and organizes it in a
data lake so it can be used to build dashboards and surface insights.

This manual is written for **technical site operators**: the people who install, configure,
run, and maintain Panorama for an organization. It documents the three open source components
of Panorama and how they fit together:

* :ref:`Panorama Extract and Load <elt_overview>` (``panorama-elt``) — the extraction agent that
  pulls data from your data sources into the data lake.
* :ref:`Panorama Open edX Backend <backend_overview>` (``panorama-openedx-backend``) — the Django
  app that serves dashboards inside the Open edX LMS.
* :ref:`Panorama MFE <mfe_overview>` (``frontend-app-panorama``) — the micro-frontend that
  renders the dashboards to users.

It also documents the :ref:`Tutor plugin for Panorama <tutor_overview>`
(``tutor-contrib-panorama``), which wires all three components together for Open edX.

.. note::

   If you run Open edX, the fastest path to a working Panorama installation is the
   :ref:`Tutor plugin for Panorama <tutor_overview>`, which wires all three components
   together. Start with that section; the component sections then explain what the plugin sets
   up and how to operate each piece.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started
   :name: getting-started-toc

   introduction
   architecture

.. toctree::
   :maxdepth: 2
   :caption: Panorama Extract and Load
   :name: elt-toc

   elt_overview
   elt_installation
   elt_datalake
   elt_configuration
   elt_commands
   elt_pipeline
   elt_docker
   elt_other_sources

.. toctree::
   :maxdepth: 2
   :caption: Panorama Open edX Backend
   :name: backend-toc

   backend_overview
   backend_modes
   backend_configuration
   backend_administration
   backend_api

.. toctree::
   :maxdepth: 2
   :caption: Panorama MFE
   :name: mfe-toc

   mfe_overview
   mfe_deployment

.. toctree::
   :maxdepth: 2
   :caption: Tutor Plugin for Panorama
   :name: tutor-toc

   tutor_overview
   tutor_installation
   tutor_configuration
   tutor_operations

.. toctree::
   :maxdepth: 1
   :caption: Reference
   :name: reference-toc

   glossary

.. rubric:: Quick Links

* :ref:`Introduction <introduction>`
* :ref:`Architecture overview <architecture>`
* :ref:`Tutor plugin (Open edX quick start) <tutor_overview>`
* :ref:`Setting up the data lake <elt_datalake>`
* :ref:`ELT command reference <elt_commands>`
* :ref:`Panorama modes <backend_modes>`
* `Panorama product site <https://panorama.aulasneo.com>`_
* `Aulasneo Website <https://aulasneo.com>`_