Difference between revisions of "Docs/Installation Guide"

From Userful Support
Jump to: navigation, search
(Created page with "placeholder.... Category:Docs")
 
(Install Prep)
 
(36 intermediate revisions by 3 users not shown)
Line 1: Line 1:
placeholder....
+
{{ Public Support Wiki}}
 +
{{DISPLAYTITLE:Downloading and Installing the Userful™ Software
 +
}}
 +
{{CopyrightNotice|{{CURRENTYEAR}}}}
  
 +
[[Category:Docs]]
  
 +
<br>
 +
{{DocsMainReturn}}
 +
<br>
  
 +
==Introduction==
  
[[Category:Docs]]
+
This document provides instructions for installing the Userful&trade; software appliance. It presents an overview of the software installation and setup stages.
 +
 
 +
The following is a typical sequence of tasks when installing the Userful&trade; software appliance:
 +
* Choose the preferred installation process language
 +
* Customize System settings in installation summary
 +
* Accept License Agreement and User account setup
 +
 
 +
== Download==
 +
Download the Userful&trade; software appliance from the [http://www.userful.com/videowall-download-form website] and get started. It can take between 10 minutes and 4 hours to complete the download process depending on the speed of your internet connection. After downloading the ISO, burn it onto a DVD or create a '''[[ Docs/How_to_create_bootable_USB#Bootable_USB_Flash_Drive |bootable flash drive]]'''.
 +
 
 +
<!--
 +
=== Verify the File (Optional) === will bring this back again (md5sum tool) check sum tool
 +
 
 +
You can check that the file downloaded correctly using a <code>md5</code> checksum program. This step is optional but recommended. Most Linux distributions come with <code>md5sum</code>, a checksum program. Otherwise, you can download the program from several online sources and use it as outlined below.
 +
 
 +
# In a terminal, enter the following, replacing [''path/to/file''] with the path to the downloaded .ISO file.
 +
#:<pre>$ md5sum [path/to/file]</pre>
 +
# The string you get from this command will look like this:
 +
#:<pre>56b7sab208gb4de5250948a1856ddd0e [filename]</pre>
 +
# Compare the string to the string in the checksum file on the download server. If it matches, the integrity and quality of the downloaded file is verified and you can burn it to a DVD.
 +
 
 +
If you are using Windows for download:
 +
# [http://www.nullriver.com/products/winmd5sum Download winMd5Sum]. Otherwise, you can download the program from several online sources and use it as outlined below.
 +
# Install it by double-clicking the .exe file.
 +
# Click on <code>Start > Programs > winMd5Sum > winMd5Sum</code>.
 +
# Click the <code>...</code> button beside the <code>File Name</code> box.
 +
# Find the downloaded .zip or .iso file that you want to check, and open it.
 +
# Get the appropriate .zip or .iso checksum from the Userful's download page, then copy and paste it into the <code>Compare</code> box.
 +
# Click the <code>Compare</code> button. A download was successful if the checksums match, If they differ you will need to download the file again.
 +
<br>
 +
 
 +
=== Verify the File (Optional) ===
 +
You can check that the file is downloaded correctly using a <code>sha1</code> checksum program. This step is optional but recommended. Most Linux distributions come with <code>sha1sum</code>, a SHA-1 checksum program. Otherwise, you can download the program from several online sources and use it as outlined below.
 +
 
 +
# In a terminal, enter the following, replacing [''path/to/file''] with the path to the downloaded .ISO file. 
 +
#:<pre>$ sha1sum [path/to/file]</pre>
 +
# The string you get from this command will look something like this:
 +
#:<pre>e1e0ccfcde4693a9618cd5d58f23c27d812a93eb [filename]</pre>
 +
# Compare the string to the string in the SHA-1 file on the download server. If it matches, the integrity and quality of the downloaded file is verified and you can burn it to a DVD.
 +
 
 +
<br>
 +
If you are using Windows, download the [https://www.microsoft.com/en-ca/download/details.aspx?id=11533 file checksum] tool and follow the instructions as mentioned in the Microsoft article https://support.microsoft.com/en-us/kb/841290 for verifying the integrity of the downloaded file.
 +
-->
 +
 
 +
==Install Prep==
 +
 
 +
If you are installing Userful software on a PC/Server that was purchased from Userful directly, you can proceed to the "Installation" step. These steps are only necessary when installing Userful on systems not supplied by Userful or one of its partners.
 +
 
 +
 
 +
As a first step, please remove any extraneous PCI devices or USB peripherals. Wifi adapters are not supported. Only one Nvidia GPU installed at a time is supported.
 +
 
 +
 
 +
It is necessary to connect a basic display to Userful in order to manage the install process. This display can not be used for signage or video wall applications.
 +
 
 +
* If your system has an Intel onboard GPU, connect a display to it
 +
* If your system has both an Intel and Nvidia GPU installed, connect a display to the Intel GPU
 +
* If your system has only an Nvidia GPU (common with Xeon CPUs), connect a display to the Nvidia GPU
 +
 
 +
 
 +
Once a display is connected, enter the BIOS or UEFI of the system and:
 +
 
 +
# Disable Secure Boot (you may need to consult documentation of your system's manufacturer to determine how this can be done)
 +
# If your system has only one storage device, disable any RAID options and enable "Legacy" control options if the installer fails to detect the drive.
 +
# Set the onboard (Intel) GPU as the primary display adapter if your system contains both an Intel and Nvidia GPU. This can be ignored if no such option exists in the BIOS
 +
# Configure the system to boot from the optical drive or USB in the BIOS
 +
 
 +
 
 +
To start the install, insert the DVD or flash drive and reboot the system.
 +
<br>
 +
<br>
 +
 
 +
== Installation ==
 +
 
 +
[[Image:Installation_Language.png |400px|right]]
 +
 
 +
Before installation begins, a customized installer will guide you through the installation process. This includes setting the date and time, selecting the system partition, language support and  keyboard layout.
 +
<ol start="1">
 +
 
 +
<li> From the first install screen, choose '''Installation Process Language'''  that will assist you through the Installation process and click “Continue”.</li><br>
 +
<br clear="all"/>
 +
 
 +
[[Image:Installation_Summary.png |400px |right]]
 +
<li> The next prompt provides '''Installation Summary'''. "Installation Process" provides options for customizing system settings. This includes setting Date & Time, Language Support, Keyboard Layout, etc.</li><br>
 +
 
 +
:* Click on the '''Date & Time''' option and select the Userul host's timezone and approximate location
 +
 
 +
:* Next choose the  default language you wish to use for the system by clicking the '''Language Support''' <br>
 +
 
 +
:* Similarly select the keyboard layout under '''Keyboard''' (e.g. English US - see image to the right)<br>
 +
 
 +
<!--:* Browse for the location of the downloaded <tt>.iso</tt> under “Installation Source”. You can also customize your installation by using other Installation Sources other than your local DVD/USB media.
 +
:* Browse for the location of the <tt>.iso</tt> file under “Installation Source”.
 +
 
 +
:* The next step allows you to choose system installation software. Select “Everything” to update all dependent packages and libraries.-->
 +
 
 +
:* Next, specify the hard drive partition. Click '''Installation Destination''', select the type of partitioning:
 +
::* "Automatically Configure Partitioning" <b>(where the entire hard drive will be formatted and you will lose all the data on that hard drive)</b>, or
 +
::* "I can configure partitioning" (manually specify the volume to be formatted and create your own layout)
 +
 
 +
:* Click '''Begin Installation'''
 +
 
 +
<br clear="all"/>
 +
</ol>
 +
Installation will begin immediately. Once done you will see the success message and, if you are installing from DVD, the DVD will eject. Remove the flash drive if you are installing from it and reboot the system.
 +
 
 +
 
 +
===Setup Process===
 +
Once the installation is complete onboard display and each connected display will show auto generated claim code as shown in the image.<br>
 +
[[Image:Claim_Code_Screen.png |400px |right]]
 +
Userful&trade; Setup process can now be performed through:
 +
* '''[[Docs/Installation_Guide#Userful_Cloud_Setup |Userful Cloud:''']]
 +
: This process allows you to manage your installs over the Internet. Click on "claim.userful.com" to register your server on Userful Cloud.
 +
* '''[[Docs/Installation_Guide#Initial_Setup |Initial Setup:''']]
 +
: This process allows you to manage your installs through Control Center. Click on "later" to proceed with the Initial Setup.
 +
<br clear="all"/>
 +
 
 +
[[Image:Enter_Claim_Code.png |400px |right]]
 +
====Userful Cloud Setup====
 +
 
 +
* Enter the auto generated claim code in the space provided
 +
 
 +
<br clear="all"/>
 +
 
 +
[[Image:Userful_Cloud_Login.png |300px |right]]
 +
* Sign up for Userful Cloud and activate your account.
 +
* Now use your login credentials to log in to Userful Cloud.
 +
* Hit the "Get Started" button.
 +
 
 +
<br clear="all"/>
 +
[[Image:Server_Card.png |300px |right]]
 +
* View you server card on Userful Cloud as shown in the image to the right and get started to manage your deployment(s) over the Internet.
 +
 
 +
<br clear="all"/>
 +
 
 +
===Initial Setup===
 +
[[File:Initial Setup.png|400 px|right|thumb|Initial Setup Screen]]
 +
<br>
 +
Configure system-level settings including license agreement, creating user account (admin), assigning hostname, and configuring the network settings on the Initial Setup screen as shown in the image to the right.
 +
 
 +
:* Network settings must be configured to access the local area network (LAN) or the Internet. It is highly recommended that a static IP address compatible with your network be set at this point.
 +
:* Type name in the "Hostname" field
 +
:* Accept the Userful [[Agreements/EULA |'''EULA''']] agreement and click '''Get started''' button to launch the "Welcome Screen".
 +
 
 +
<br>
 +
{|{{Notes}}
 +
|
 +
'''Note:''' The hostname you create should contain only alpha-numeric characters and hyphens (-). Other characters -- including a period/dot (.) -- are not supported. For example, test-computer is a valid hostname, but test.computer is not. Similarly, do not give "localhost" or "admin" as hostname. These are reserved keywords.<br>
 +
|}
 +
<br>
 +
<br>
 +
<!--
 +
{{#evt:
 +
service=youtube
 +
|id=https://www.youtube.com/watch?v=vXZM0H1jUrU&t=55s
 +
|dimensions=560x315
 +
|alignment=right
 +
|container=frame
 +
}}
 +
''Please Watch this video for a quick guide on '''How to Install Userful Video Wall'''.''
 +
<br clear="all" />
 +
 
 +
 
 +
<br clear="all"/>-->
 +
 
 +
<!--
 +
== External Packages ==
 +
<br clear="all" br>
 +
[[File:VW_Install_Third_Party.png|right|300px]]
 +
All the CentOS-provided software packages that come with a base Userful&trade; install are free and open source and can be redistributed under various open-source licensing schemes. However, several essential packages (such as media codecs, Adobe Flash and Reader, etc.) cannot be redistributed freely and must be downloaded and installed from proprietary repositories.
 +
<br>
 +
Userful has provided a convenient method for installing these packages through the "Third-party Add-ons" feature inside of the Control Center. You can access the Control Center from your web browser. Once the Control Center has been launched you can move your mouse over <code>System Operations > Third party Add-ons</code> which will expand the menu and display the link to '''Install/Uninstall Third-party Add-ons'''.
 +
<br>
 +
Simply, select the package and hit "Apply" to start the installation process. No reboot required after the process.
 +
<br clear="all"/>
 +
-->
 +
 
 +
<!--
 +
== Software Updates ==
 +
[[File:Check_for_Updates.png|right|400px]]
 +
The Userful team is continually working to improve product stability and feature set. Occasionally, Userful may release important maintenance updates between official software version releases.
 +
 
 +
The best way to install Userful and other system updates is to use the "System Updates" feature under <tt>Control Center > System Operations</tt>. To do so:
 +
* Open Control Center > System Operations and click "Check for Updates"
 +
* Select option as per your maintenance contract and click "Continue" and follow update prompts
 +
<br>
 +
'''Please Note:''' An active internet connection and a valid support and maintenance contract is required to access the software updates.
 +
 
 +
<br clear="all"/>
 +
-->
 +
==Related  Links==
 +
* [[Docs/Setup Guide | Setup Guide]]
 +
* [[Docs/HowTos/Change_BIOS_Settings| How to configure BIOS settings]]
 +
* [[Docs/System Hardware Guide | Hardware Guide]]
 +
* [[Docs/Network_Requirements_for_Userful_Appliance |Ports used by Userful Appliance]]
 +
* [[Docs/FAQs/Hardware_Compatibility |Frequently Asked Questions]]
 +
 
 +
 
 +
{{forcewhitespace}}

Latest revision as of 13:49, 17 January 2019


Copyright © 2019 Userful Corporation. All rights reserved.
(Updated 2019.01.17)


To return to the main documentation page, Click Here.



Introduction

This document provides instructions for installing the Userful™ software appliance. It presents an overview of the software installation and setup stages.

The following is a typical sequence of tasks when installing the Userful™ software appliance:

  • Choose the preferred installation process language
  • Customize System settings in installation summary
  • Accept License Agreement and User account setup

Download

Download the Userful™ software appliance from the website and get started. It can take between 10 minutes and 4 hours to complete the download process depending on the speed of your internet connection. After downloading the ISO, burn it onto a DVD or create a bootable flash drive.


Install Prep

If you are installing Userful software on a PC/Server that was purchased from Userful directly, you can proceed to the "Installation" step. These steps are only necessary when installing Userful on systems not supplied by Userful or one of its partners.


As a first step, please remove any extraneous PCI devices or USB peripherals. Wifi adapters are not supported. Only one Nvidia GPU installed at a time is supported.


It is necessary to connect a basic display to Userful in order to manage the install process. This display can not be used for signage or video wall applications.

  • If your system has an Intel onboard GPU, connect a display to it
  • If your system has both an Intel and Nvidia GPU installed, connect a display to the Intel GPU
  • If your system has only an Nvidia GPU (common with Xeon CPUs), connect a display to the Nvidia GPU


Once a display is connected, enter the BIOS or UEFI of the system and:

  1. Disable Secure Boot (you may need to consult documentation of your system's manufacturer to determine how this can be done)
  2. If your system has only one storage device, disable any RAID options and enable "Legacy" control options if the installer fails to detect the drive.
  3. Set the onboard (Intel) GPU as the primary display adapter if your system contains both an Intel and Nvidia GPU. This can be ignored if no such option exists in the BIOS
  4. Configure the system to boot from the optical drive or USB in the BIOS


To start the install, insert the DVD or flash drive and reboot the system.

Installation

Installation Language.png

Before installation begins, a customized installer will guide you through the installation process. This includes setting the date and time, selecting the system partition, language support and keyboard layout.

  1. From the first install screen, choose Installation Process Language that will assist you through the Installation process and click “Continue”.


  2. Installation Summary.png
  3. The next prompt provides Installation Summary. "Installation Process" provides options for customizing system settings. This includes setting Date & Time, Language Support, Keyboard Layout, etc.

    • Click on the Date & Time option and select the Userul host's timezone and approximate location
    • Next choose the default language you wish to use for the system by clicking the Language Support
    • Similarly select the keyboard layout under Keyboard (e.g. English US - see image to the right)


    • Next, specify the hard drive partition. Click Installation Destination, select the type of partitioning:
    • "Automatically Configure Partitioning" (where the entire hard drive will be formatted and you will lose all the data on that hard drive), or
    • "I can configure partitioning" (manually specify the volume to be formatted and create your own layout)
    • Click Begin Installation


Installation will begin immediately. Once done you will see the success message and, if you are installing from DVD, the DVD will eject. Remove the flash drive if you are installing from it and reboot the system.


Setup Process

Once the installation is complete onboard display and each connected display will show auto generated claim code as shown in the image.

Claim Code Screen.png

Userful™ Setup process can now be performed through:

This process allows you to manage your installs over the Internet. Click on "claim.userful.com" to register your server on Userful Cloud.
This process allows you to manage your installs through Control Center. Click on "later" to proceed with the Initial Setup.


Enter Claim Code.png

Userful Cloud Setup

  • Enter the auto generated claim code in the space provided


Userful Cloud Login.png
  • Sign up for Userful Cloud and activate your account.
  • Now use your login credentials to log in to Userful Cloud.
  • Hit the "Get Started" button.


Server Card.png
  • View you server card on Userful Cloud as shown in the image to the right and get started to manage your deployment(s) over the Internet.


Initial Setup

Initial Setup Screen


Configure system-level settings including license agreement, creating user account (admin), assigning hostname, and configuring the network settings on the Initial Setup screen as shown in the image to the right.

  • Network settings must be configured to access the local area network (LAN) or the Internet. It is highly recommended that a static IP address compatible with your network be set at this point.
  • Type name in the "Hostname" field
  • Accept the Userful EULA agreement and click Get started button to launch the "Welcome Screen".


Note: The hostname you create should contain only alpha-numeric characters and hyphens (-). Other characters -- including a period/dot (.) -- are not supported. For example, test-computer is a valid hostname, but test.computer is not. Similarly, do not give "localhost" or "admin" as hostname. These are reserved keywords.




Related Links