===========================================================
			*** Ubuntu Server Client (deamon) Installation Guide ***
			===========================================================


1- System Requirements:

	1.1) Hardware:
		Processor: Minimum 2+ GHz Dual-core ARM
		Memory (RAM): 4 GB
	
	1.2) Software:
		Ubuntu Server 18.x.x (64 bit)
		Ubuntu Server 20.x.x (64 bit)


2. Prerequisites / Dependencies:

        Ubuntu Server Client installer/ package will install its dependencies automatically at the time of installation through their standard package manager.


3- Install invisily-clientd:

	3.1) Open terminal in that directory where invisily client package is downloaded and Install Invisily client by running script by following command in terminal:
        
                   sudo ./install_ubuntu20_server_s2s.sh

	3.2) Once invisily client will be installed, you will be asked to choose network interfaces from displayed list of network interfaces for sniffer configuration e.g.
	     Select network interface:
	     1) enp0s3
	     2) wlp5s0
	      
	3.3) Choose valid option from above displayed network interfaces to proceed. e.g. 1 or 2
	
	3.4) Once all configuration done, the message "Configured and installed S2S client successfully!" will be displayed in terminal.


4- How to provide the user credentials to the Invisily service:

	First run the Invisily application by running the following commands to provide the valid user credentials.

        4.1) Move to Invisily directory by  : cd /opt/invisily/linuxclientd/bin/

        4.2) Run the Invisily client with sudo : sudo ./invisily_backend -t s2s and provide dummy credentials (first time only).
                                
                                ( OR )

        	 Run the Invisily client with sudo : sudo ./invisily_backend -u "dummy" -p "dummy" -t s2s

        4.3) Invisily client will send the on-boarding request to web portal and register device on success.

        4.4) Invisily client will run in background on first login. All the assigned services will be available now to the user.

        4.5) If Invisily is not running, then user can run Invisily on front-end with:
        
                (i)     cd /opt/invisily/linuxclientd/bin/
                (ii)    sudo ./invisily_backend -u "dummy" -p "dummy" -t s2s
        
        4.6 User can terminate the application by Ctrl+C.

        Note : Credentials are required for 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/client_data/configs"


5- How to start / stop / check status of Invisily:

    	5.1) Open Terminal and start the service by running the following command in terminal:
            
	            sudo systemctl start invisily_watchdog.service

    	5.2) Check the status of the service by running the following command in terminal.
            
		    sudo systemctl status invisily_backend.service
           
	5.4) In case of successful login and verifications, a list of available/assigned services will be saved to log file. 
	 In case of unsuccessful login, error information / message will be saved to log file.
	 (This log file is used to view the ip & ports or access information of allowed services.)

	 To view the log file, please run the following command in terminal:
        
        	    sudo nano  /opt/invisily_updates/serviceinvisily.log

	5.5) Stop the service by running the following command in terminal.

		    sudo systemctl stop invisily_watchdog.service
		    sudo systemctl stop invisily_backend.service
  
  
6- How to Troubleshoot:

	The debug and error log files are maintained at the installation path (/opt/invisily/linuxclientd/client_data/log/).


7- How to Un-Install
   
	7.1) Open Terminal and run the following command:

		    sudo apt-get purge invisily-client


Caution :  If you intentionally or unintentionally uninstall the client please request administrator to send you new client package. Don't install old package.