*** Installation Guide for Invisily Gateway ***
            ==============================================

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 Invisily Gateway

    i-   Open Terminal and assign permissions to installation script "install_invisily_gateway.sh" by running following command in terminal.
            sudo chmod a+x install_invisily_gateway.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_gateway.sh --installation-type=online --install --kafka-servers-ips=<ip address of server> --kafka-port=<port> --kafka-topic=<topic>
        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_gateway.sh --installation-type=offline --install --kafka-servers-ips=<ip address of server> --kafka-port=<port> --kafka-topic=<topic>

    ii-  B. To run gateway 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_gateway.sh --installation-type=online  --install --multi-home --kafka-servers-ips=<ip address of server> --kafka-port=<port> --kafka-topic=<topic>
        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_gateway.sh --installation-type=offline  --install --multi-home --kafka-servers-ips=<ip address of server> --kafka-port=<port> --kafka-topic=<topic>

    iii- A. Select CLIENTS side Network Interface by entering number (Accesssible for Clients)

    iii- B. In case you have selected --multi-home, you will be prompted to select CLIENTS side second Network Interface by entering number (Accesssible for Clients)

    iv-  Select SERVICE side Network Interface by entering number (Accesssible for Services)

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

3- How to on-board Invisily Gateway (Get Device ID)

    i-   Run the Gateway to get the Device ID by the following commands.

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

        2-   Run the script "gateway.sh" by running following command in terminal. (This script runs the Gateway and sniffer services in the background)
                sudo ./gateway.sh start

        3-   You can check the status of the gateway & sniffer services by running following command in terminal.
                sudo ./gateway.sh status

        4-   Running following command in terminal to get the Device ID from the log file.
                grep -m1 -Eo "\[\w{32}\]" /var/log/invisily/linuxgateway/gw.log

    ii-  Add the Device ID of gateway in web potal "Gateways" section by Edit relvant gateway or send to Administrator for adding it to web portal.

    iii- Stop the Gateway and re-run the gaetway once Device ID is updated at web portal.


4- How to Run Invisily Gateway

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

    ii-  Run the script "gateway.sh" by running following command in terminal. (This script runs the Gateway and sniffer services in the background)
            sudo ./gateway.sh start

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


5- How to Stop Invisily Gateway

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

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

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

6- How to Remove/Uninstall

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

7- How to Troubleshoot Invisily Gateway

    i-  Gateway Server log files are available at "/var/log/invisily/linuxgateway/".
    ii- Gateway Sniffer log files are available at "/var/log/invisily/sniffer/".