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

- [System Requirements](#system-requirements)
  - [Hardware](#hardware)
  - [Software](#software)
- [Pre-requisites](#Pre-requisites)
- [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)

## Pre-requisites

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

## Installation

Open Terminal and assign permissions to debian installer/package
"invisily_client.deb" by running following command:

```bash
sudo chmod a+x invisily_client.deb
```

Install Invisily client by running following command:

```bash
sudo apt-get install ./invisily_client.deb
```

## 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 credentials (first time only):

```bash
sudo ./invisily_backend
```

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

```bash
sudo ./invisily_backend -u {username} -p {password}
```

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

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
sudo nano  /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 remove 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.