Welcome to OrchestraOS Documentation!
=====================================

OrchestraOS is a Linux distribution developed and maintained by CTHINGS.CO and generated from the Yocto Project build system. It is tailored to provide a basis for modern edge deployments and can be customized through BSP layers and application layers.

.. note::

   This is the Scarthgap engineering documentation. Use the
   **Documentation branch** selector to inspect the available series;
   only ``scarthgap`` is currently available. Wrynose documentation is in
   preparation and is not selectable.

- **Getting Started:** Follow the :ref:`orchestra-os-quickstart` to build the OrchestraOS.
- **Supported Targets:** Explore physical gateways and virtual machines
  in :ref:`os-supported-targets`.
- **OS Architecture:** Start with :ref:`os-architecture`, then explore
  software and applications, storage and updates, and boot and provisioning.
- **OS Security Architecture:** Learn about :ref:`os-security-architecture` in the OrchestraOS.
- **Optional Extensions:** Explore extended security, NetHSM signing,
  and machine-learning capabilities in :ref:`os-optional-extensions`.
- **Orchestra Manager Integration:** Review the device-side integration
  requirements in :ref:`os-runtime-services`.
- **Signing Keys Generation:** Learn how to generate and use :ref:`os-signing-keys`.
- **Release Cycle and Vulnerability Management:** Find out :ref:`os-release-cycle` process.
- **Software Bill of Materials (SBOM):** Get detailed :ref:`os-sbom`.
- **LTS Versions:** Find available versions and their documentation in
  :ref:`os-lts-versions`.


.. **Table of Contents**

.. Keep paths absolute: this page is reused verbatim as a sub-page of the Orchestra
   documentation, where it is not the root document.

.. toctree::
   :maxdepth: 1
   :hidden:

   /chapters/orchestra-os/orchestra-os-intro.rst
   /chapters/orchestra-os/orchestra-os-quickstart.rst
   /chapters/orchestra-os/supported-targets.rst
   /chapters/orchestra-os/os-architecture.rst
   /chapters/orchestra-os/os-security-architecture.rst
   /chapters/orchestra-os/optional-extensions.rst
   /chapters/orchestra-os/runtime-services.rst
   /chapters/orchestra-os/signing-keys.rst
   /chapters/orchestra-os/release-cycle.rst
   /chapters/orchestra-os/sbom.rst
   /chapters/orchestra-os/documentation-versions.rst


.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Resources
   
   CTHINGS.CO Website <https://cthings.co>
   Support <https://support.cthings.co>
   NXP i.MX Software <https://www.nxp.com/design/design-center/software/embedded-software/i-mx-software:IMX-SW>