*** Installation Guide for Invisily Thin Client Bridge ***
            ==============================================


1- System Requirements:
    1.1. Hardware
        Processor: Minimum 2+ GHz Dual-core x86
        Memory (RAM): 4 GB
        Network Interfaces: 2

    1.2. Software
        Ubuntu 22.04 (64 bit)

    1.3.
        1.3.1- 1 x Network Interface connected to Internet/Network where it can access Invisily Infrastructure. (We call it Network Interface # 1)
        1.3.2- 1 x Network Interface connected to devices which will going to access Invisily through Thin Client Bridge. (We call it Network Interface # 2)
               a.  Setup static IP Address on this interface, prefereably 192.168.0.1/24. Thin Client Bridge uses this /24 by default. (Read section # 7 to get help in setting up Static ip in Ubuntu 18.04 x64)
               b.  In case you would like to use any other /24, then you you can setup its first ip address as static ip address on this Network Interface.
                   Ex. For IP Address range 192.168.100.0/24, first usable IP 192.168.100.1/24 would be configured on this Network Interface.


2- How to Install

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

    2.2- Run the installation script by running following command in terminal.
         a. If you want to use default IP Range 192.168.0.0/24 and have 192.168.0.1 configured for Network Interface,
            "sudo ./install_invisily_thin_client_bridge.sh --install --kafka-servers-ips=<ip address of server> --kafka-port=<port> --kafka-topic=<topic>"
         b. If you want to use custom IP Range, then you would have to enter that custom IP Range in argument
            "sudo ./install_invisily_thin_client_bridge.sh --install --dhcp-ip-range=192.168.100.0/24 --dhcp-gw-ip=192.168.100.1 --kafka-servers-ips=<ip address of server> --kafka-port=<port> --kafka-topic=<topic>"

3- How to provide the user credentials to the Invisily Thin Client Bridge.

    First run the invisily application on front-end by running the following commands to provide the valid user credentials.

    3.1 Change the directory to : cd /opt/invisily/linuxclientd/bin/

    3.2 Run the invisily client with sudo : sudo ./invisily_backend

    3.3 Provide the valid user credentials (user,password)

    3.4 Invisily client will send the on-boarding request to web portal or login (registered device) successfully.

    3.5 Terminate the application by Ctrl+C.

    Note : This is for the first time only, Invisily client will save valid credentials for next login. If user credentials expire or user want to change credentials,
    please remove the "cred.data" from /opt/invisily/linuxclientd/bin/.

    3.6 Approve user from Admin Portal

    3.7 Once approved, start invisily service using below command

        sudo systemctl start invisily_backend



4- How to connect clients to Invisily Thin Client Bridge

    4.1- You can connect client with Network Interface # 2 of Thin Client Bridge, this interface is running DHCP Server
    4.2- Once you will connect a client to Network Interface # 2, you will get an ip address via DHCP
    4.3- You can access http://services.inv in browser inside client, to see the list of availabel services
    4.4- You can access listed services to confirm that you can access those services.


5- How to Un-install/Remove

    5.1- Open Terminal and run.
         sudo ./install_invisily_thin_client_bridge.sh --remove


6- How to Troubleshoot

    6.1- The debug and error log files are maintained at the path (/var/log/invisily/invisily-thin-client-bridge).


7- How to setup Static IP address on second Network Interface

    7.1- Considering name of second Network Interface is eth1

    7.2- Go to /etc/netplan/ directory.

    7.3- For example you might find there a default netplan configuration file called 01-netcfg.yaml or 50-cloud-init.yaml
         with a following content instructing the networkd deamon to configure your network interface via Static:

         ethernets:
            eth1:
            dhcp4: no
            addresses: [192.168.0.1/24]

    7.4- Save file and run apply command

         sudo netplan apply

    7.5- In case you run into some issues execute:

         sudo netplan --debug apply