> ## Documentation Index
> Fetch the complete documentation index at: https://docs.loqate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Online Installation

This section will describe online installation scenario where the user is able to connect to the internet and has a license key, and proceeds to download and install the data packs.

## Installation Steps

1. Run Install Manager using License key
2. Download the required datapacks (`*.lfz` files)
3. Install the data packs

The following sections demonstrate the steps in the data installation process.

## Graphical User Interface Mode

Install Manager can be started in GUI mode by providing the command line option: `mode=gui`. GUI mode is the default mode on Windows platforms. On Windows platforms, Install Manager can be launched by double clicking on `InstallManager.bat`.

The first screen displays the version of the Local API currently installed, at the lower left corner.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image1.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=c49e3f62acc64b6245c97615fa162aba" width="516" height="404" data-path="images/IM_Online_image1.png" />
</Frame>

If a proxy server is used, the checkbox "Use Proxy Server" needs to be checked and the Proxy server name and port need to be entered as shown below. If the proxy server needs authentication, the checkbox "Use authentication for proxy server" should also be checked and the user name and password need to be provided.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image2.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=cb8cc55368887cd654e1e0b7d7143f7c" width="513" height="403" data-path="images/IM_Online_image2.png" />
</Frame>

The first step is to provide the installation folder.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image3.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=6c9fb514667fdf522a7a09fc9f63e87d" width="520" height="402" data-path="images/IM_Online_image3.png" />
</Frame>

The next step is to provide a license key. When a license key is entered, Install Manager will communicate with `licensing.loqate.com`. If the license key is valid, the server will return the corresponding license pack to Install Manager and then Install Manager will write the license pack to the installation folder.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/IM_Online_image4.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=d72ccbe9221e3e16a35fce65086f75bf" width="513" height="405" data-path="images/IM_Online_image4.png" />
</Frame>

Once the license pack is saved to disk, Install Manager will display the contents of the license for reference.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/IM_Online_image5.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=387ac1851bfa145b526f15fa1efc96e0" width="517" height="404" data-path="images/IM_Online_image5.png" />
</Frame>

There are 2 options available for downloading as shown below. One can either just download the data packs or install the data packs that are already downloaded to the local machine.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/IM_Online_image6.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=021e6148b314aa0d8cb6cf5ee0542ac0" width="517" height="406" data-path="images/IM_Online_image6.png" />
</Frame>

After a valid option is selected, Install Manager will communicate with `licensing.loqate.com` and fetch details about the latest available licensed data packs that are compatible with the Local API version that is currently installed. The details of available data packs to install will be shown next. In the case a user selects an existing data folder for installation, it will show newer data packs available to download and install. The release date of the available data packs will also be displayed. The user can select the required data packs from this screen by checking the checkboxes next to each product.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/IM_Online_image7.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=acb4d0003a6b42ad77c56729807e8c35" width="515" height="402" data-path="images/IM_Online_image7.png" />
</Frame>

If the user selects the download option, Install Manager will download the data packs.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/IM_Online_image8.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=a7fe57acf6e3c10a6bafeaa65ad2b5ce" width="514" height="403" data-path="images/IM_Online_image8.png" />
</Frame>

The download can be paused and resumed at any point. If the "Pause Download" button is pressed the UI will change as follows:

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/IM_Online_image9.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=4f060cc4ba299659d0d1b83e3e9f1528" width="516" height="403" data-path="images/IM_Online_image9.png" />
</Frame>

The next screen displays location where the downloaded data packs will be installed.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image10.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=502ed56af286e60983a0b2864d79679e" width="514" height="403" data-path="images/IM_Online_image10.png" />
</Frame>

Next, the user is shown the Loqate data license agreement.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image11.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=9ebdac7b4207c70ca1480ab41660eaa4" width="520" height="404" data-path="images/IM_Online_image11.png" />
</Frame>

Once the user accepts the license agreement, the next screen will proceed to installing the selected data packs.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image12.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=856e626630c86eda117ae671e577cc69" width="518" height="405" data-path="images/IM_Online_image12.png" />
</Frame>

Finally, Install Manager will complete the installation as shown.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image13.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=1b7b0fb4b4a0977a3d6bf9bf81b3b7fd" width="515" height="406" data-path="images/IM_Online_image13.png" />
</Frame>

## Command Line Interface Mode

Install Manager can be started in command line mode by providing the command line option: `mode=commandline`. Command line mode is the default in Linux and UNIX platforms. On Linux/Unix platforms, Install Manager can be launched by running the script `InstallManager.sh`. The first screen displays the version of the Local API currently installed.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image14.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=3e7f8274324af178d4ef0bf1f96cf95d" width="605" height="425" data-path="images/IM_Online_image14.png" />
</Frame>

If a proxy server is used, the Proxy server name and port need to be entered as shown below. If the proxy server needs authentication, the user name and password need to be provided.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image15.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=98da6919d67b9ed3de2862c416d72e25" width="602" height="428" data-path="images/IM_Online_image15.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image16.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=7f16f86453eac61b6fe16647dbc491c8" width="601" height="424" data-path="images/IM_Online_image16.png" />
</Frame>

The first step is to provide the installation folder. If the user selects an empty folder the installation will proceed as a fresh installation of the data packs. If the user selects an existing data folder, the installer will proceed as an update installation.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image17.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=9356b0681371208d548014159f048160" width="604" height="423" data-path="images/IM_Online_image17.png" />
</Frame>

The next step is to provide a license key. When a license key is entered, Install Manager will communicate with `licensing.loqate.com`. If the license key is valid, the server will return the corresponding license pack to Install Manager and then Install Manager will write the license pack to the installation folder.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image18.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=35ea8f117e4c1647f829ccd425891fb9" width="603" height="398" data-path="images/IM_Online_image18.png" />
</Frame>

One can either just download the data packs or install the data packs that are already downloaded to the local machine.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image19.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=08e504978e354a95daa3a85c8adc2548" width="603" height="397" data-path="images/IM_Online_image19.png" />
</Frame>

When the list of available data packs is shown, enter `all` to select all data packs. Alternatively, if only certain products are desired for installation, enter the numbers next to those products, ending the selection by entering `done`.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image20.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=af12bc6546f5b61f6dfedf03ad8a3ec5" width="606" height="425" data-path="images/IM_Online_image20.png" />
</Frame>

The screen below shows the Loqate License agreement.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image21.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=713b7aa53ef7f20d4b88a4a6d45e20e4" width="599" height="359" data-path="images/IM_Online_image21.png" />
</Frame>

Depending on the choice made for download and installation, Install Manager may download data packs from `download.loqate.com`.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image22.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=5992149f45a53b40a2645e86aa75ee34" width="604" height="425" data-path="images/IM_Online_image22.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image23.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=374e7e125ff58892b249ff5f6e8288f8" width="603" height="425" data-path="images/IM_Online_image23.png" />
</Frame>