<!-- omit in toc -->
# Ubuntu Installation Guide

- [System Requirements](#system-requirements)
  - [Hardware](#hardware)
  - [Software](#software)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Login](#login)
- [Status Check](#status-check)
- [Troubleshoot](#troubleshoot)
- [Uninstall](#uninstall)

## System Requirements

### Hardware

- Processor: Minimum 2+ GHz Dual-core x86
- Memory (RAM): 4 GB

### Software

- Ubuntu Server 18.x.x (64 bit)
- Ubuntu Server 20.x.x (64 bit)

## Prerequisites

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

## Installation

Open terminal in that directory where invisily client package is downloaded and Install Invisily client by running script by following command in terminal:

```bash
sudo ./install_ubuntu_server_s2s.sh
```

- 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
  
- Choose valid option from above displayed network interfaces to proceed. e.g. 1 or 2
- Once all configuration done, the message "Configured and installed S2S client successfully!" will be displayed in terminal.

**Note**   After completion of sniffer configuration, If ip address assigned to interface is changed by the admin. Then user needs to reconfigure the sniffer by following below steps:
           1) Change to Invisily configs directory by running below terminal command:
        
              ```bash
              cd /opt/invisily/linuxclientd/client_data/configs
              ```
           2) Open 'sniffer_config.cfg' file in editing mode by running below terminal command:
        
              ```bash
              sudo nano sniffer_config.cfg
              ```
           3) Following setting will appear on terminal screen:
              interface="enp0s3"
              ip="10.0.2.15"
           4) Update the respective field of ip with new ip address.
           5) To save the changes, press 'ctrl+x' then press 'y' and finally press 'enter'.
           6) In the last step, user has to restart 'invisily_sniffer.service' for reconfigure sniffer successfully by running below terminal command:
           
              ```bash
              sudo systemctl restart invisily_sniffer.service
              ```

## Login

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

Change to Invisily directory:

```bash
cd /opt/invisily/linuxclientd/bin/
```

Run the Invisily client with sudo and provide dummy credentials (first time only):

```bash
sudo ./invisily_backend -u "dummy" -p "dummy" -t s2s
```

Or run the Invisily client with `sudo` and provide credentials within the command:

```bash
sudo ./invisily_backend -u "dummy" -p "dummy" -t s2s
```

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

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

If Invisily is not running, then user can run Invisily on front-end with

```bash
cd /opt/invisily/linuxclientd/bin/
sudo ./invisily_backend -u "dummy" -p "dummy" -t s2s
```

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"

## Status Check

Open Terminal and start the service by running the following command in
terminal:

```bash
sudo systemctl start invisily_watchdog.service
```

Check the status of the service by running the following command in terminal.

```bash
sudo systemctl status invisily_backend.service
```

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:

```bash
cat  /opt/invisily/linuxclientd/client_data/logs/invisilyd_update_service.log
```

Stop the service by running the following command in terminal.

```bash
sudo systemctl stop invisily_watchdog.service
sudo systemctl stop invisily_backend.service
```

## Troubleshoot

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

## Uninstall

Open Terminal and run the following command:

```bash
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.