*** Installation Guide for Invisily Controller ***
            ==============================================


1- Supported Platforms:

    1.1. AMD
	    1.1.1 Hardware Requirements
	        Processor: Minimum 2+ GHz Dual-core x86
	        Memory (RAM): 8 GB
        1.1.2. Software Requirements
            Ubuntu 22.04 (64-bit)

    1.2. ARM v8
	    1.2.1 Hardware Requirements
	        Processor: Minimum 2+ GHz Dual-core ARMv8
	        Memory (RAM): 8 GB
        1.2.2. Software Requirements
            Ubuntu 22.04 (64 bit)


2- How to Install

    i-    Open Terminal and assign permissions to installation script "install_invisily_controller.sh" by running following command in terminal.
             "sudo chmod a+x install_invisily_controller.sh"

    ii-   A. Run the installation script by running following command in terminal.
            a. For online install (Your machine should be connected to Internet)
             "sudo ./install_invisily_controller.sh --installation-type=online  --install"
            b. For offline install on AMD (Your machine should be having Invisily provided Ubuntu 18.04.5 OS image). Offline installation option is not supported for ARM.
             "sudo ./install_invisily_controller.sh --installation-type=offline  --install"

    ii-   B. To run controller on 2 Network Interfaces (Multi-Home), Run the installation script by running following command in terminal.
            a. For online install (Your machine should be connected to Internet)
             "sudo ./install_invisily_controller.sh --installation-type=online  --install --multi-home"
            b. For offline install on AMD (Your machine should be having Invisily provided Ubuntu 18.04.5 OS image). Offline installation option is not supported for ARM.
             "sudo ./install_invisily_controller.sh --installation-type=offline  --install --multi-home"

    iii-  A. Select the Network Interface for the Controller (Sniffer) Deployment

    iii-  B. In case you have selected --multi-home, you will be prompted to select second Network Interface.

    vi-  At the end of successful installation the message "Invisily-controller has been installed successfully ..." will be displayed.

    NOTE : In LDAPs support we need DNS server IPs to resolve URL to IP, to enable DNS query as the sniffer blocks all the traffice at INPUT chain, Controller gets the DNS Server IPs from Network interface connection settings (Same network interface as user selected when controller installation script prompts for network interface selection) and read the protocol from controller settings file (ctrl.ini) default value is "udp" and add the rules in iptables to enable dns query at the time of starting.


3- How to Run

    i-   Open Terminal and change directory to installation directory path by running following command in terminal.
            cd /opt/invisily/sdp-controller/bin/

    ii-  Run the script "controller.sh" by running following command in terminal. (They script will runs the Controller and Sniffer as two separate services in background)
            sudo ./controller.sh start

    iii- You can check the status of the controller by running following command in terminal.
            sudo ./controller.sh status


4- How to Stop

    i-   Open Terminal and change directory to installation directory path by running following command in terminal.
            cd /opt/invisily/sdp-controller/bin/

    ii-  Run the script "controller.sh" by running following command in terminal.
            sudo ./controller.sh stop

    iii- You can check the status of the controller by running following command in terminal.
            sudo ./controller.sh status

5- How to Remove/Uninstall

    i-  To Remove/Uninstall, you can run
            "sudo ./install_invisily_controller.sh --remove"


6- How to Troubleshoot

    i-  Controller log files are available at "/var/log/invisily/sdp-controller/".
    ii- Controller Sniffer log files are available at "/var/log/invisily/sniffer/".