Contents
========


* `Contents <#contents>`__

  * `Web Vision GUI <#web-vision-gui>`__

    * `Requirements <#requirements>`__

      * `Software packages requirements <#software-packages-requirements>`__
      * `Pulling the Source code <#pulling-the-source-code>`__

    * `Getting Started <#getting-started>`__

      * `Building and Configuring EIS Services <#building-and-configuring-eis-services>`__
      * `Building and Configuring GUI Services <#building-and-configuring-gui-services>`__
      * `Configuring GUI Service <#configuring-gui-service>`__
      * `Start the application <#start-the-application>`__
      * `Uninstall <#uninstall>`__

Web Vision GUI
--------------

Requirements
^^^^^^^^^^^^

Software packages requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


* Docker CE - version 24.0.2 or higher
* Docker compose - version 2.21.0 or higher
* repo (Google-built repository-management tool that runs on top of Git)

.. code-block:: bash

   # 1. Install docker
   curl -fsSL https://get.docker.com -o get-docker.sh
   sudo -E sh get-docker.sh
   # add current user to the docker group
   sudo usermod -aG docker $USER
   # configure both daemon proxy and docker client proxy
   # include 192.0.0.0/8 and 10.0.0.0/8 as no_proxy if required
   # include ".iind.intel.com" as part of docker client noProxy list in config.json file if required

   # 2. Install repo package to sync the source code
   sudo -E apt install repo

Pulling the Source code
~~~~~~~~~~~~~~~~~~~~~~~

`Note`: Steps to setup EIS might not be updated via command below. Refer to [EIS Manifest release instruction](https://github.com/intel-innersource/applications.industrial.edge-insights.manifests/releases) for the updated instruction or command to setup EIS. First time image build will take around ~35 mins.

.. code-block:: bash

   repo init -u https://github.com/intel-innersource/applications.industrial.edge-insights.manifests.git
   repo sync 


   # use EIS pre-requisites.sh script or run command below manually to avoid proxy clean up by pre-requisites.sh script
   cd IEdgeInsights/build/
   sudo -E apt install python3-pip
   pip3 install -r requirements.txt

   # setup EIs env and build docker images
   cd IEdgeInsights/WebVision/
   ./setup.sh -d eis

Getting Started
^^^^^^^^^^^^^^^

Usage of ``./setup.sh``

.. code-block:: sh

   # setup.sh has following options 
   # Usage: ./setup.sh <option>
   # Description: Default option will setup the environment and build docker images
   # -c | --clean = Enable clean build application
   # -b | --build_images = Build the frontend and backend images
   # -d | --dependency = Build the dependent services which would be needed to be deployed (eg: -d eis)
   # -f | --force = Disable all prompt. Use default value
   # -m | --minimum_code = Clean up source code
   # -u | --uninstall = Uninstall all software setup
   # -v | --verbose = Show verbose output
   ./setup.sh --clean|-c --build_images|-b --dependency eis|-d eis --force|-f  --minimum_code|-m --uninstall|-u --verbose|-v

Building and Configuring EIS Services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To Configure environment and build WebVision Frontend and Backend docker images. First time images build will take around ~30 mins.

.. code-block:: bash

   ./setup.sh -d eis

Building and Configuring GUI Services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To Configure environment and build WebVision Frontend and Backend docker images. First time images build will take around ~30 mins.

.. code-block:: bash

   ./setup.sh -b

Configuring GUI Service
~~~~~~~~~~~~~~~~~~~~~~~

To Configure environment, 

.. code-block:: bash

   ./setup.sh

Start the application
~~~~~~~~~~~~~~~~~~~~~

Run the application

.. code-block:: bash

   ./run.sh

..

   ***Note:**  ETCD changes(EIS configuration) get will be reverted to default values when project is deactivated and re-activated._


Uninstall
~~~~~~~~~

This will remove all docker volumes and current user data. Images are not removed

.. code-block:: bash

   ./setup.sh -u