> ## 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.

# Offline Installation

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

In order to proceed with offline installation, the license pack and the data packs need be downloaded separately in a machine which has internet connectivity and then copied over to the install machine so that the Install Manager can access them at install time.

## Recommended Installation Steps

1. Download License pack on a machine with internet access using the License Key
2. Download datapacks (`*.lfz` files) on a machine with internet access
3. Copy the downloaded license pack and downloaded datapacks to the machine where they have to be installed (with no internet access)
4. Run the Install Manager on the install machine to install the datapacks

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

## Graphical User Interface Mode

### Download

Install Manager should be run on a machine which can access the internet.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image1-e1420596320437.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=1a407e6fb92275c81b885eb8eb64a2c0" width="472" height="369" data-path="images/IM_Online_image1-e1420596320437.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%20(1).png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=35919c8f90bdeddb7475cdf1cf7b5815" width="513" height="403" data-path="images/IM_Online_image2 (1).png" />
</Frame>

The first step is to provide the installation folder. The Loqate License Pack will be written to this folder. Until 2015Q1 release, the Loqate license pack was named `loqateLicense`. From 2015Q1 release the license pack format is changed from `loqateLicense` to `license.lfs`.

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

In the next step 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%20(1).png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=959e8211c50d571a163ca6738cf171ca" width="513" height="405" data-path="images/IM_Online_image4 (1).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%20(1).png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=42667fcd770132fa530e74729a256a75" width="517" height="404" data-path="images/IM_Online_image5 (1).png" />
</Frame>

There are 2 options available for downloading as shown below. Select the "Download datapacks" option to download the required datapacks.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/IM_Online_image6%20(1).png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=d29aab4bcdb8625ff4b42a462b207b0b" width="517" height="406" data-path="images/IM_Online_image6 (1).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%20(1).png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=bced48cfa73067ba48bbc0752e233b17" width="515" height="402" data-path="images/IM_Online_image7 (1).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%20(1).png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=ee26e39c59fcc408da7a7be7f7630b2a" width="514" height="403" data-path="images/IM_Online_image8 (1).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%20(1).png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=8a8e70f38edc9d90943e83d80377905a" width="516" height="403" data-path="images/IM_Online_image9 (1).png" />
</Frame>

The next screen displays location where the downloaded data packs will be installed. Since the datapacks are to be installed on a different machine, the installation can be stopped at this stage by closing the window or by the 'Cancel' button.

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

### Installation

Once the downloaded license pack and datapacks are copied to the Install machine, run the Install Manager on the install machine.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image1-e1420596320437%20(1).png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=880963b2a9245f0856d2fefb7bbfd9d6" width="472" height="369" data-path="images/IM_Online_image1-e1420596320437 (1).png" />
</Frame>

Select the installation folder, the license pack can be placed in this folder.

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

Choose the option "I have a license pack" and select the license pack file. From 2015Q1 release onwards, if the older format license pack `loqateLicense` is selected, it will be changed to the new format `license.lfs`

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

Install Manager will display the contents of the license for reference.

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

In the next screen choose the option "use local data packs" and select the folder where the downloaded datapacks were copied to.

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

The available datapacks will be displayed for selection. Once the required datapacks are selected for installation, continue by clicking 'Next' button.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Offline_image26.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=9a185df831bb5284fedb9794a758261f" width="516" height="401" data-path="images/IM_Offline_image26.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_Offline_image27.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=ab72997c26db4ea00fcc0c2ea1fc02a7" width="516" height="403" data-path="images/IM_Offline_image27.png" />
</Frame>

Next, the user is shown the data license agreement.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Offline_image28.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=3b194a496584ad21fd873ff7da28cbd8" width="514" height="403" data-path="images/IM_Offline_image28.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_Offline_image29.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=b345b53952f64623eb668dff79f5a48e" width="515" height="400" data-path="images/IM_Offline_image29.png" />
</Frame>

Finally, Install Manager will complete the installation as shown. The install folder will now have the `*.lfs` files along with `*_manifest.properties` for the datapacks which were selected for installation.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image13%20(1).png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=65bb2e52a3c40ed76450c464b0cb034d" width="515" height="406" data-path="images/IM_Online_image13 (1).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`.

### Download

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%20(1).png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=8283e3899ead4b271aecaa009ac1d809" width="605" height="425" data-path="images/IM_Online_image14 (1).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%20(1).png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=fe4dd34722149644c327859a918fcf89" width="602" height="428" data-path="images/IM_Online_image15 (1).png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Online_image16%20(1).png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=2517c0f7b2ab744e35a115e4c9905d9d" width="601" height="424" data-path="images/IM_Online_image16 (1).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%20(1).png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=00769e7c77dcd7ed428a8b897c4123b8" width="604" height="423" data-path="images/IM_Online_image17 (1).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. Choose the option to download the datapacks.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Offline_image30%20(1).png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=7b154350f8d6d7d6e3c7fb27307fd849" width="604" height="435" data-path="images/IM_Offline_image30 (1).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`. Install Manager downloads data packs from `download.loqate.com`.

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

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

### Installation

Once the downloaded license pack and datapacks are copied to the Install machine, run the Install Manager on the install machine.

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

Select the installation folder, the license pack can be placed in this folder. Choose the option "I have a license pack" and select the license pack file. From 2015Q1 release onwards, if the older format license pack `loqateLicense` is selected, it will be changed to the new format `license.lfs`.

Install Manager will display the contents of the license for reference.

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

Choose the option "install using locally available data packs" and select the folder where the downloaded datapacks were copied to.

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

The available datapacks will be displayed for selection.

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

Next, the user is shown the data license agreement.

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

Once the user accepts the license agreement, the Install Manager will proceed to installing the selected data packs.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/ovuMLzhaeZg77OvL/images/IM_Offline_image37.png?fit=max&auto=format&n=ovuMLzhaeZg77OvL&q=85&s=2cc9bfbafdfa01a2045dcdb243924950" width="608" height="408" data-path="images/IM_Offline_image37.png" />
</Frame>
