Manta Manager
=============

This guide will walk you through the installation process of the Manta Manager, covering all the required dependencies and steps to set up your environment.

Dependencies
------------

To successfully install and run Manta Manager, you need to have the following dependencies installed:

MongoDB
*******

MongoDB is used as the database by Manta Manager to store essential information such as swarms, nodes, tasks, logs, and results.

Installation on Linux
^^^^^^^^^^^^^^^^^^^^^

1. Import the MongoDB public GPG Key:

.. code:: bash
    
    wget -qO - https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -

2. Create a list file for MongoDB:

.. code:: bash
    
    echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list

3. Reload the local package database:

.. code:: bash
        
    sudo apt-get update

4. Install MongoDB:

.. code:: bash
    
    sudo apt-get install -y mongodb-org

5. Start MongoDB:

.. code:: bash
    
    sudo systemctl start mongod

Installation on Windows and MacOS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For Windows and macOS, please refer to the official MongoDB documentation for installation instructions:

- `MongoDB Installation on Windows <https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/>`_
- `MongoDB Installation on macOS <https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/>`_

Mosquitto Broker
****************

Mosquitto is an MQTT broker used by Manta Manager to facilitate communication between nodes and the manager.

**MQTT** (Message Queuing Telemetry Transport) is a lightweight messaging protocol designed for connections with remote locations where a small code footprint is required or network bandwidth is limited.

Installation on Linux
^^^^^^^^^^^^^^^^^^^^^

1. Update your package list:

.. code:: bash
    
    sudo apt-get update

2. Install Mosquitto:

.. code:: bash
    
    sudo apt-get install -y mosquitto mosquitto-clients

3. Start Mosquitto:

.. code:: bash
    
    sudo systemctl start mosquitto

Installation on Windows and macOS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For Windows and macOS, please refer to the official Mosquitto documentation for installation instructions: `Mosquitto Installation Guide <https://mosquitto.org/download/>`_

.. note::

   While the Mosquitto broker doesn't need to be deployed on the same machine as the Manta Manager, it must be accessible by both the nodes and the manager. The simplest setup is to deploy the broker on the same machine as the manager.

Installing Manta Manager
------------------------

The recommended way to install Manta Manager is by using pre-built packages, which simplify the setup process and ensure all dependencies are correctly configured.

1. **Download the Wheel File**: Obtain the pre-built wheel file for the Manta Manager from the official release `repository <https://github.com/mantatech/manta-manager-python/releases>`_.

2. **Install the Wheel File**: Use `pip` to install the downloaded wheel file. Run the following command in your terminal:

.. code:: bash

   pip install manta_manager-<version>-py3-none-any.whl

This installation method minimizes compatibility issues and is ideal for most users.