

# Installing Elemental Live on qualified hardware
Installing on qualified hardware

This section is for IT administrators who perform the first-time installation of AWS Elemental Live software on a hardware unit that is considered *qualified hardware*. For information about hardware that AWS Elemental considers to be qualified hardware, contact your AWS Elemental Sales representative or contact AWS Elemental Support through the [AWS Elemental Support Center](https://console.aws.amazon.com/elemental-appliances-software/home?region=us-east-1#/supportcenter).

To install Elemental Live, you work on two systems:
+ A Windows, macOS, or Linux *workstation* that has access to the public internet.
+ The *hardware unit* (Elemental Live node) that you are setting up. This unit doesn't need access to the internet. In fact, we recognize that usually this unit won't have access.

**Prerequisite knowledge**

We assume that you know how to do the following:
+ Log in to the AWS Elemental hardware unit over Secure Shell (SSH) in order to run install commands via the command line interface.
+ Use Windows Share (on a Windows workstation), Samba (on a macOS workstation), or a utility such as SCP (on a Linux workstation) to move files.
+ Access recently downloaded files on your workstation.

**Note**  
In this procedure, we show how to install version 2.25.4 of the Elemental Live. Wherever an instruction shows 2.25.4, modify your commands to specify the version that you are installing. 

**Topics**
+ [

# Step A: Prepare hardware and download files
](install-lv-ig-prep.md)
+ [

# Step B: Install (kickstart) the operating system software
](install-lv-ig-install-ks.md)
+ [

# Step C: Install the Elemental Live software
](install-lv-ig-install-sw.md)
+ [

# Step D: Set up licenses
](install-lv-ig-licensing.md)
+ [

# Step E: Complete node configuration
](install-lv-ig-complete.md)

# Step A: Prepare hardware and download files


## Prepare hardware and network


To prepare your hardware and network, make sure the following steps are complete:
+ You have physically installed (racked) the hardware unit.
+ You have set up the unit as a node on your organization's network.
+ You have configured network cards and ensured that they're able to reach other machines on the network.
+ You have set up a method, such as SCP, for transferring files between your workstation and the node.

## Note your activation code


You should have received an email with your activation code. You need this number for the installation. 

If you're installing Elemental Live software on more than one hardware unit, you received an activation code for each instance. Decide which activation code you will use for each unit, and make a note. The codes are not tied ahead of time to any specific hardware unit, but you cannot use the same code on more than one.

## Download installation files


Download the installation files for Elemental Live.

**To download installation files**

1. Log in to [AWS Elemental Support Center Activations](https://console.aws.amazon.com/elemental-appliances-software/home?region=us-east-1#/activations). For detailed steps to download installation files, see [Downloading Elemental Live software](detailed-dl-lv-ig.md).

1. Download your files.

   You need the following files for Elemental Live: 
   + A kickstart file (`.iso`) file for creating a USB boot drive. For example, `centos-20161028T12270-production-usb.iso`. 

     You use this file to put a preconfigured installation of your operating system on your physical hardware unit. If you're downloading the kickstart file for several products, make a note of which file belongs to which product. Files are not interchangeable across products.
   + An installation (`.run`) file for the Elemental Live software itself. For example:

      `elemental_production_live_2.25.4.12345.run`.

## Create bootable kickstart


At your workstation, use a third-party utility (such as PowerISO or ISO2USB) to create a bootable USB drive from the `.iso` file. For help, see [ this knowledge base article](https://us-east-1.console.aws.amazon.com/elemental-appliances-software/home?region=us-east-1#/viewknowledge/https://us-east-1.console.aws.amazon.com/elemental-appliances-software/home?region=us-east-1#/viewknowledge/How-to-create-bootable-recovery-kickstart-media-Windows-and-Apple-OS-X).

# Step B: Install (kickstart) the operating system software
Step B: Kickstart the OS

Install the operating system on the node. This action is known as *kickstarting* the system.

**To kickstart the system**

1. Insert the USB thumb drive into the hardware unit.

1. Restart the system using the following command.

   ```
   [elemental@hostname ~]$ sudo reboot
   ```

1. Use the arrow keys to select each option and complete the field, using the instructions in the following table as a guide.  
****    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/elemental-live/latest/installguide/install-lv-ig-install-ks.html)

   The operating system is installed.

1. At the `Press return to quit` prompt, press **Enter** to reboot the system.

# Step C: Install the Elemental Live software
Strong passwords

The guide has been updated in several sections to include a recommendation to set always set a strong password.New options for enabling the OCR conversion feature

The installer now includes more options for enabling this feature, specifically to support setup on a node that doesn't have access to the internet.

Perform these steps on each AWS Elemental Live hardware unit, either directly at the hardware unit or from your workstation via SSH. 

**Topics**
+ [

## About Installer Options
](#install-live-sw-about-options)
+ [

## Setting up OCR Conversion in Versions 2.22.0 to 2.23.0
](#install-live-sw-ocr-2220)
+ [

## Setting up OCR Conversion in Versions 2.23.1 and later
](#install-live-sw-ocr-2231)
+ [

## Installing the Software
](#install-live-sw-procedure)

## About Installer Options


To install Elemental Live, you run the installer. The installer has options that control the way the installer works:
+ *Action options *instruct the installer to perform an action. For example, `--cleandb` instructs the installer to clean out the database.
+ *Skip options *instruct the installer to omit specific prompts. For example, `--skip-tz` instructs the installer to skip the timezone prompt.

To display built-in help about all the options, log in with the *elemental* user credentials, then enter this command at the Linux command line:

```
[elemental@hostname ~]$ sudo sh ./elemental_live_cpu_2.25.4.12345.run --help
```

### The skip-all Installer Option


The installer has a `--skip-all` option that skips all the prompts and performs the default choice for all options.

You should only use this option after you have followed the following procedure, and you have read the built-in help carefully.

The `--skip-all` option means that the installer won't present prompts. It will perform some actions using default information.

## Setting up OCR Conversion in Versions 2.22.0 to 2.23.0


The installer for Elemental Live versions 2.22.0 to 2.23.0 includes an option to set up the feature to convert captions using OCR conversion. (For information about the OCR feature, see [Support for OCR Conversion](https://docs.aws.amazon.com/elemental-live/latest/ug/support-for-ocr.html) in the *AWS Elemental Live User Guide*.)

**To set up this feature**

**Note**  
The Elemental Live node must have a connection to the internet. It needs this connection because the installer must download the OCR libraries from the internet. These libraries are language dictionaries used in the conversion.  
If the node doesn't have an internet connection, consider upgrading to a version after version 2.23.0. Newer versions of Elemental Live include more options for installing the OCR feature.

Run the installer with these options: 
+ With the `--install-ocr` option. You won't be presented with prompts to set up OCR. Instead, the installer will automatically set it up.
+ You can include or omit the `--skip-all` option, depending on whether you want to be presented with prompts for other features.

**To omit the feature**

If you don't want to set up this feature, run the installer with these options:
+ Without the `--install-ocr` option. The installer won't set up the OCR feature. 
+ You can include or omit the `--skip-all` option.

## Setting up OCR Conversion in Versions 2.23.1 and later


The installer for Elemental Live version 2.23.1 and later includes several options to set up the feature to convert captions using OCR conversion. (For information about the OCR feature, see [Support for OCR Conversion](https://docs.aws.amazon.com/elemental-live/latest/ug/support-for-ocr.html) in the *AWS Elemental Live User Guide*.)

Setting up this feature involves three steps:
+ Downloading the OCR libraries from the internet. These libraries are language dictionaries that are used in the captions conversion.
+ Installing the libraries on the node.
+ Enabling the OCR feature.

**To set up the feature on a node with access to the internet**

Run the installer with these options:
+ With the `--install-ocr` option. The installer will download the libraries from the internet, install them on the node, and enable the OCR feature. You won't be presented with prompts to set up OCR.
+ You can include or omit the `--skip-all` option, depending on whether you want to be presented with prompts for other features.

**To set up the feature on a node without internet access**

1. Download the OCR libraries file [live-ocr-tesseract-data.zip](http://d3v4cjmjhvrkiz.cloudfront.net/live-ocr-tesseract-data.zip).

   Keep the file zipped.

1. Use a method such as SCP to move the zipped file to a location on the Elemental Live node that you are setting up. For example, move to this location:

   `/home/live-ocr-tesseract-data.zip`

1. Run the installer with these options:
   + With the `--install-ocr-zip` option. This option includes a parameter for the folder where you copied the libraries file. For example: 

     `-- install-ocr-zip /home/live-ocr-tesseract-data.zip`

      You won't be presented with prompts to set up OCR.
   + You can include or omit the `--skip-all` option, depending on whether you want to be presented with prompts for other features.

**To omit the feature**

If you don't want to set up this feature, run the installer with these options:
+ Without the `--install-ocr` option. The installer won't install or enable the OCR feature.
+ With the `--skip-ocr` option. If you don't include this option, you will be presented with prompts to install OCR, even though you didn't include the `--install-ocr` option.
+ You can include or omit the `--skip-all` option, depending on whether you want to be presented with prompts for other features.

## Installing the Software


**To install the software**

1. At the Linux command line, log in with the *elemental* user credentials. 

1. Decide which options you want to include with the installer. You can include options in the command to automate some of the installation. To display built-in help about all the options, enter this command:

   ```
   [elemental@hostname ~]$ sudo sh ./elemental_live_cpu_2.25.4.12345.run --help
   ```

1. Run the installer as follows. Use the actual file name of your `.run` file, rather than the example below.

   For GPU and CPU versions of the software.

   ```
   [elemental@hostname ~]$ sudo sh ./elemental_production_live_2.25.4.12345.run  options
   ```

   For CPU-only versions of the software.

   ```
   [elemental@hostname ~]$ sudo sh ./elemental_production_live_cpu_2.25.4.12345.run options
   ```

1.  Follow the prompts. This table specifies the prompts that appear when you don't include any options for the installer.    
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/elemental-live/latest/installguide/install-lv-ig-install-sw.html)

   When the software install is complete, this message appears:

   ```
   Installation and configuration complete!
   ```

1. Start a web browser and start the Elemental Live web interface by typing the following:

   ```
   https://<hostname>
   ```

   Make sure the web interface displays.

# Step D: Set up licenses
Setting up licenses

The sections on setting up licenses on AWS Elemental Live hardware units and on VMs has been revised to fix several errors in the procedure.

At this point, the software is installed but it is not yet enabled. 

You must now generate and install the license file on each node.

The license generation procedure works as follows: 
+ You receive an email with activation codes, one for each instance of the product (Elemental Live) that you purchased. At each Elemental Live hardware unit, you use one activation code to generate a key file. The key file incorporates the specific activation code and the specific hostname of the hardware unit. The key file works only with this activation code's product (Elemental Live) and with this hardware unit. 
+ You copy the key file from the node to your workstation. At your workstation, you open the AWS Elemental Support Center console and generate a license using each key file. Like the key file used to generate it, the license file is valid only for this product (Elemental Live) and this specific hardware unit.
+ After you generate the license file, you copy it to the hardware unit that it belongs to, and use the CLI to install the license.

**Topics**
+ [

## Organize your activation codes
](#install-live-license-retrieve)
+ [

## Generate a key file
](#install-live-license-generate)
+ [

## Generate a license
](#install-live-license-download)
+ [

## Install the license files
](#install-live-license-install)

## Organize your activation codes


**To organize the activation codes:**

1. Locate the email you received from AWS Elemental. This email contains an activation code or codes, one for each Elemental Live software instance that you have purchased. The activation code looks like this:

   `LVE-111-222-333`

   If you didn't receive this email or have lost it, contact AWS Elemental Support through the [AWS Elemental Support Center](https://console.aws.amazon.com/elemental-appliances-software/home?region=us-east-1#/supportcenter).

1. If you have more than one activation code, each activation code specifies the hardware configuration that the code applies to. For example, it specifies that the code is for hardware that is comparable to an L820 appliance.

   Identify the hardware unit that applies for each access code. For example, identify the hardware unit (and its hostname) that is comparable to the L820 appliance. Make a note of the assignments. For example, you might assign as follows:

   `LVE-111-222-333` with the hardware unit that has the hostname `SystemA`.

   `LVE-111-222-444` with the hardware unit that has the hostname `SystemB`.

## Generate a key file


You must generate a key file using a utility that always exists on the operating system of the hardware unit. 

**To generate a key file**

Perform this step at each Elemental Live hardware unit.

1. Using an SSH client such as PuTTY, log in to the hardware unit with the *elemental* user credentials. 

   You are logged in at the home directory (`/elemental`).

1. Enter this command:

   ```
   [elemental@hostname ~] ./keygen
   ```

1. At the prompt, enter the activation code that belongs to this hardware unit. The following *key file* is created in the home directory: `activation_<hostname of the system>.key`.

   For example, `activation_SystemA.key`

1. Copy the key file from the hardware unit to your workstation. We recommend that you copy all the key files to a specific folder on your workstation. Give the folder a suitable name such as `elemental_live_license_keys`. Make a note of the path because you will need it in [the next step](#install-live-license-generate).

1. Repeat these steps for each Elemental Live hardware unit. Make sure that you use a different activation code on each hardware unit.

## Generate a license


You must log on to the AWS Elemental Appliances & Software console, and use the key file to generate a license.

**Note**  
This procedure assumes that an administrator in your organization has set you up as an AWS IAM user, with the permissions that you need to generate licenses. For more information, see [AWS Elemental Appliances and Software Service Getting Started Guide](https://amzn.to/AWSElementalSerGSG).   
It also assumes that you have your IAM credentials (user name and password). If you don't have these credentials, speak to an administrator in your organization. AWS Elemental can't provide you with these credentials.

**To generate a license**

Perform this step at your workstation.

1. Open the AWS Elemental Appliances & Software console at [https://console.aws.amazon.com/elemental-appliances-software/](https://console.aws.amazon.com/elemental-appliances-software/). 

1. On the navigation pane of the AWS Elemental Appliances & Software home page, choose **Activations**. The **Activations List** page appears. Choose the **Ready to license** tab.

   The **Ready to license** tab shows one entry for each product that you purchased. Each product is identified by a product name and a unique activation code. The activation code is the code that you [received in the email](#install-live-license-retrieve). Following from our example, you might see two lines:

   `LxxxPNL LVE-111-222-333 Live product 2021-11-01`

   `LxxxPNL LVE-111-222-444 Live product 2021-11-01`

1. Choose the **Generate license** button (at the top-right corner of the tab). The **Generate new license** page appears.

1. On the **Generate new license** page, choose the **Choose files** button, and navigate to the folder that you [copied the key files to](#install-live-license-generate). For example, `/elemental_live_license_keys`.

   In the dialog box that appears, select all the key files that you generated, then choose **Open**.

   On the **Generate new license** page, one entry appears for each key file. For example:

   ```
   activation_systemA.key
   15.39 KB
   11/04/2021, 2:02:01 PM
   
   activation_systemB.key
   15.39 KB
   11/04/2021, 2:32:22 PM
   ```

1. Choose **Generate license**. A license is generated for each entry. After the **License generated** message appears, the product for each license moves to the **Activations** tab.

**Download the license files**

1. On the **Activations** tab, choose one of the entries you want to set up. The **Product details** page appears for this product. 

1. Choose the **Software** tab and look for the **License file** link.

1. Choose the **License file** link and follow the prompts to download the file. 

1. Repeat these steps to download all the license files that you generated.

1. Follow the procedure that applies to your browser to open the folder that contains the downloaded license files. Make a note of the folder where the license files are located. 

**About the License Files**

Each license file is named as follows: `lic-download-<hostname>.tgz`

For example: `lic-download-systemA.tgz`

Each `tgz` license file contains the main license for Elemental Live and licenses for all the add-on packs that you purchased.

The licenses work only with the specific product and the specific hardware unit.

## Install the license files


When you [downloaded the license files](#install-live-license-download), you should have made a note of the folder where these files were downloaded to on your workstation. You must now transfer each file to its hardware unit and install it.

**To transfer the license to the hardware unit**
+ Use a method such as SCP to move the license file (the `.tgz` file) from your workstation to a location on the Elemental Live hardware unit. We recommend that you copy the file to a folder with a name like `elemental_licenses`.

  Make sure that you put the correct license on each hardware unit. The license only works on a specific hardware unit.

**To install the license on the hardware unit**

On each hardware unit, you must set up Elemental Live to use the license file. 

1. Using an SSH client such as PuTTY, log in to the hardware unit with the *elemental* user credentials.

   You are logged in at the home directory (`/home/elemental`).

1. Navigate to the directory that contains the license file, and extract the `.lic` files from the `.tgz` file. Place the `.lic` files in these folders:

   `/home/elemental`

   `/opt/elemental_se`

1. Enter the following command to restart the Elemental Live service:

   `[elemental@hostname ~]$ sudo service elemental_se restart`

# Step E: Complete node configuration


You have now installed and performed the basic initial configuration of Elemental Live. Use the following table to determine which guide to use to complete the node configuration. 


| Scenario | Guide | 
| --- | --- | 
| Elemental Live in a stand-alone configuration. Elemental Live is not managed by AWS Elemental Conductor Live. | [AWS Elemental Live Configuration Guide](https://docs.aws.amazon.com/elemental-live/latest/configguide/) | 
| Multiple Elemental Live nodes managed by AWS Elemental Conductor Live. | [AWS Elemental Conductor Live Configuration Guide](https://docs.aws.amazon.com/elemental-cl3/latest/configguide/) | 