.. IMPORTANT
   This page is linked to the ORC Add device button. If you change the structure of this documentation and the link to this page changes, the link in the ORC Manager has to be updated.

   Also, for some reason the order of a comment, bash highlight line and page tag "add-device" is important, and reference only works in this order.

.. highlight:: bash

.. _add-device:

How to add a Device
====================

To add your Linux device to the Orchestra platform, you need to install the Orchestra daemon on your device and register it with the platform. The following tutorial provides a step-by-step guide on how to accomplish this.


Video Tutorial
-------------------

.. raw:: html

    <iframe width="560" height="315" src="https://www.youtube.com/embed/85p7CbKg2n0?si=hfOXVpz6FMrrnCc7" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>


.. _installing-orchestra-daemon:

Installing Orchestra Daemon
----------------------------

First, please make sure you have access to the device's terminal (:ref:`console-access`) and the device has internet access (:ref:`internet-access`).

.. toctree::
   :maxdepth: 1

   console-access.rst
   internet-access.rst
   
Once that is done, you can proceed to install the Orchestra Daemon by executing the following command in the terminal:

.. code-block:: bash

   curl -sSL https://content.cthings.co/static/orchestrad/install.sh -o install.sh && sudo chmod +x install.sh && sudo ./install.sh && rm install.sh

This command retrieves the installation script from the provided URL and pipes it to the ``bash`` shell, executing it with superuser privileges.

Enter the command in the terminal and press Enter to start the installation process.

After executing the command, the Orchestra daemon installation script will be downloaded and run with administrative permissions, automatically setting up the necessary components on your Linux device.

.. _register-device:

Register device with the platform
----------------------------------

Once the installation is complete, you will receive a secret code and a link that you need to use to add your device to the Orchestra platform. Follow the steps below to complete the process:

1. Open a web browser on your computer and go to the following link: `<https://login.cthings.co/login/device>`_.

2. Enter a unique **device code** provided on your device's CLI at the end of the installation process.

3. On the next step you are asked to log in with your CTHINGS.CO ONE account. You should already have an account, log in using your credentials.

4. The Orchestra platform will process your request and add the device to your account. Once the process is complete, you will be redirected to the Orchestra platform dashboard.

5. On the Orchestra platform dashboard, you will find a list of your devices, including the newly added device.

Congratulations! You have successfully added your Linux device to the Orchestra platform. You can now manage and monitor your device using the platform's features and capabilities.

.. note::
    The Orchestra platform provides various features to manage and orchestrate your devices efficiently. Explore the platform's documentation and features to make the most out of your device management experience.


.. _updating-orchestra-daemon:

Updating Orchestra Daemon
----------------------------

If you already have your devices on Orchestra but need to update Orchestra Daemon to enable new features run the following command asa a root or with ``sudo``:

.. code-block:: bash

    /etc/orchestrad/orchestrad-update.sh