==================
OSDx Documentation
==================

##########
About OSDx
##########

**OSDx** (*Open SDx*) is a network operating system based on Debian GNU/Linux
that can be run on standard ``amd64/x86`` systems and proprietary ``arm64``
and ``armhf`` devices.

:doc:`Here <intro/about>`, you can find more information on OSDx.

###############
Getting started
###############

First, check out the :doc:`intro/distribution` chapter to learn about the distribution
bundles provided by Teldat.

Check out the :doc:`intro/setting_up/index` chapter to learn how to install OSDx, use
licenses to enable features and functionalities, and verify the installation. To learn
more about managing an OSDx system see :doc:`management/index`.

The :doc:`intro/quickstart` chapter provides quick recipes for accessing the system and
setting up basic features. You may also draw some inspiration from the
:doc:`examples/index` chapter.

Learn how to master the OSDx CLI by reading the :doc:`intro/cli` chapter. Additionally,
the complete CLI hierarchy can be found under :doc:`commands/cfg/index` and
:doc:`commands/op/index`.

.. toctree::
    :hidden:
    :titlesonly:

    intro/about
    intro/distribution

.. toctree::
    :caption: First steps
    :hidden:

    intro/setting_up/index
    intro/quickstart
    intro/licensing
    intro/cli
    intro/configuration

.. toctree::
    :caption: Admin Guide
    :hidden:

    management/index
    articles/index
    troubleshooting/index

.. toctree::
    :hidden:
    :titlesonly:

    examples/index

.. toctree::
    :caption: Command reference
    :hidden:
    :titlesonly:
    :glob:

    commands/cfg/index
    commands/op/index