Difference between revisions of "Docs/Installation Guide"

From Userful Support
Jump to: navigation, search
(Install Prep)
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{ Public Support Wiki}}
 
{{ Public Support Wiki}}
{{DISPLAYTITLE:Downloading and Installing the Userful™ Software Appliance
+
{{DISPLAYTITLE:Downloading and Installing the Userful™ Software
 
}}
 
}}
{{CopyrightNotice|{{REVISIONYEAR}}}}
+
{{CopyrightNotice|{{CURRENTYEAR}}}}
  
 
[[Category:Docs]]
 
[[Category:Docs]]
Line 9: Line 9:
 
{{DocsMainReturn}}
 
{{DocsMainReturn}}
 
<br>
 
<br>
__TOC__
 
  
 
==Introduction==
 
==Introduction==
  
This document provides instructions for installing the Userful&trade; software appliance.  
+
This document provides instructions for installing the Userful&trade; software appliance. It presents an overview of the software installation and setup stages.
  
Typical sequence of tasks when installing the Userful&trade; software appliance are:
+
The following is a typical sequence of tasks when installing the Userful&trade; software appliance:
* Choose the preferred Installation Process Language
+
* Choose the preferred installation process language
* Customize System settings in Installation Summary
+
* Customize System settings in installation summary
* Set Root Password
+
 
* Accept License Agreement and User account setup
 
* Accept License Agreement and User account setup
  
 
== Download==
 
== Download==
Download Userful&trade; software appliance from the [http://www.userful.com/products/downloads website] and get started. It takes 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 '''[[ Manuals/How_to_create_bootable_USB#Bootable_USB_Flash_Drive |bootable flash drive]]'''.
+
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]]'''.
  
 
<!--
 
<!--
Line 57: Line 55:
 
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.
 
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 ==
 
== Installation ==
To install, simply configure the system to boot from the optical drive, insert the DVD, and reboot the system. However, if you are using bootable USB flash drive for installation, configure the system to boot from the USB, plug-in the USB flash drive, and reboot the system.
 
  
<br><br>
+
[[Image:Installation_Language.png |400px|right]]
[[Image:Installation_Language.png |600px|right]]
+
  
Before installation begins, a customized installer will guide you through the installation process. This includes setting the date and time, language support, keyboard layout, root password, assigning a hostname and creating user account.
+
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">
 
<ol start="1">
  
Line 70: Line 93:
 
<br clear="all"/>
 
<br clear="all"/>
  
[[Image:Installation_Summary.png |600px |right]]
+
[[Image:Installation_Summary.png |400px |right]]
<li> Next Prompt provides '''Installation Summary'''. "Installation Summary" provides options for customizing system settings. This includes setting Date & Time, Language Support, Keyboard Layout, Assigning a Hostname etc.</li><br>
+
<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 host PC/server's timezone
+
:* 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>
 
:* Next choose the  default language you wish to use for the system by clicking the '''Language Support''' <br>
Line 82: Line 105:
 
:* Browse for the location of the <tt>.iso</tt> file under “Installation Source”.
 
:* Browse for the location of the <tt>.iso</tt> file under “Installation Source”.
  
:* Next step allows you to choose system installation software. Select “Everything” to update all dependent packages and libraries.-->
+
:* 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:
+
:* Next, specify the hard drive partition. Click '''Installation Destination''', select the type of partitioning:
::* "Automatically Configure Partitioning" (where entire hard drive will be formatted and you will loose all the data on that hard drive), or
+
::* "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)
+
::* "I can configure partitioning" (manually specify the volume to be formatted and create your own layout)
 +
 
 +
:* Click '''Begin Installation'''
  
 
<br clear="all"/>
 
<br clear="all"/>
[[Image:Configuring_Network.png |600px|right]]
+
</ol>
:* Next configure Network and set Hostname for your host PC/server. Network Settings must be configured to access the local area network or the Internet. The default network settings are correct for most installations. To enable '''Network''', click '''Network and Hostname''' link:
+
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.
:::* Switch the Ethernet button to "ON"
+
 
:::* Type name in the "Hostname" field
+
 
<br>
+
===Setup Process===
{|border="0" cellpadding="4" cellspacing="0" style="width:50%; padding:.5em 1em; background:#ffdddd; border:none;"
+
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]]
'''Note:''' The hostname you give 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>
+
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"/>
 
<br clear="all"/>
  
:* Click '''Begin Installation'''
+
[[Image:Enter_Claim_Code.png |400px |right]]
[[Image:Root_Password.png|600px|right]]
+
====Userful Cloud Setup====
 +
 
 +
* Enter the auto generated claim code in the space provided
  
<li>Installation will begin immediately and as it proceeds set the '''root''' password  under '''Configuration''' Prompt (for system administration and troubleshooting)</li><br>
 
 
<br clear="all"/>
 
<br clear="all"/>
[[Image:Initail_setup.png |600 px|right]]
+
 
<li>Once done you will get success message. Reboot the system and accept the Userful’s End User License agreement ([[Agreements/EULA |'''EULA''']]) and create new user for system access.</li>
+
[[Image:Userful_Cloud_Login.png |300px |right]]
<br>
+
* Sign up for Userful Cloud and activate your account.
* Click '''Finish Configuration''' to launch login screen.
+
* Now use your login credentials to log in to Userful Cloud.
 +
* Hit the "Get Started" button.
 +
 
 
<br clear="all"/>
 
<br clear="all"/>
</ol>
+
[[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"/>-->
  
 
<!--
 
<!--
Line 122: Line 186:
 
Simply, select the package and hit "Apply" to start the installation process. No reboot required after the process.
 
Simply, select the package and hit "Apply" to start the installation process. No reboot required after the process.
 
<br clear="all"/>
 
<br clear="all"/>
 +
-->
  
 +
<!--
 
== Software Updates ==
 
== Software Updates ==
[[File:Check_for_Updates.png|right|600px]]
+
[[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 Userful team is continually working to improve product stability and feature set. Occasionally, Userful may release important maintenance updates between official software version releases.  
  
Line 135: Line 201:
 
<br clear="all"/>
 
<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}}
 
{{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