Difference between revisions of "Docs/Setup Guide"

From Userful Support
Jump to: navigation, search
 
(20 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
Userful™: Setup Guide
 
Userful™: Setup Guide
 
}}
 
}}
{{CopyrightNotice}}
+
{{CopyrightNotice|{{CURRENTYEAR}}}}
 
{{DocsMainReturn}}
 
{{DocsMainReturn}}
  
 
==Introduction==
 
==Introduction==
  
This page will walk you through setting up your Userful appliance and network zero clients. Please read it entirely before beginning, and ensure you have all the prerequisite components.
+
This page will walk you through setting up your Userful appliance and network zero client receivers. Please read it entirely before beginning, and ensure you have all the prerequisite components.
 
+
<br>
This guide is for IT administrators and other users who are already familiar with basic networking and operating system deployment.
+
 
+
Prior experience with Linux or thin/zero clients is not necessary to deploy Userful.
+
 
+
==Checklist==
+
 
+
Before you begin, ensure you have all the necessary components.
+
 
+
* A copy of the [http://www.userful.com/videowall-download-form latest version of Userful&trade;]
+
* Your Userful license key
+
* A [[Docs/System_Hardware_Guide#Certified_PCs | certified or compatible computer]] to act as the Userful host, with at least a temporary accompanying monitor, keyboard and mouse for the installation phase
+
* A compatible [[Docs/Nvidia_Offload_Support | Nvidia offload card]] is recommended
+
* If applicable, a compatible [[Docs/Supported_Capture_Cards | capture card]] for video walls
+
* One compatible [[Docs/Supported_Zero_Client_Devices | zero client]] for each display. Note that Userful bundles a compatible zero client with each software license purchased.
+
* Necessary accessories for each zero client - keyboards, mice, displays
+
* A network switch with sufficient ports to deliver 1Gbps connectivity to each zero client, and at least 1Gbps to the Userful host
+
** A 10Gbps uplink (between Userful host and switch) is recommended if the Userful host will be serving more than 25 displays concurrently
+
::'''Note:''' Ideally an '''unmanaged''' Gigabit switch should be used for network configuration. If you are using a managed switch, it should be configured to perform only the basic switching functionality.
+
* Category-5e (or Cat-6a) Ethernet cabling throughout is recommended. Category-6a is recommended for 10Gbps uplinks
+
 
+
Optional components:
+
 
+
* Userful highly '''recommends''' the installation of router or a second Network Interface Card into Userful host. For more details, please visit[[#Network_Preparation | Network Preparation]] section.
+
* Internet connection for easier access to Userful Support, sharing files, or streaming content from a CMS
+
 
<br>
 
<br>
 
 
{{#evt:
 
{{#evt:
 
service=youtube
 
service=youtube
|id=https://www.youtube.com/watch?v=y6PTmdZAyG0
+
|id=https://www.youtube.com/watch?v=y6PTmdZAyG0?rel=0
 
|dimensions=560x315
 
|dimensions=560x315
 
|alignment=right
 
|alignment=right
 
|container=frame
 
|container=frame
 +
|urlargs=rel=0
 
}}
 
}}
  
 
''Please watch this video to know about basic requirements and steps for installing Userful&trade; software appliance and for quick tour of Userful Control Center.''
 
''Please watch this video to know about basic requirements and steps for installing Userful&trade; software appliance and for quick tour of Userful Control Center.''
 
<br clear="all">
 
<br clear="all">
<br>
 
<br>
 
Once all the components are ready, refer to [[Docs/Setup_Guide#Network_Preparation |Network Preparation]] section for the network guidelines.
 
  
==Network Preparation==
+
=Prerequisites for Userful=
  
[[File:Network-Station-Setup.png|thumb|right|560px|An example of setup configuration]]
+
Userful is a powerful, flexible solution for delivering video walls and digital signage in many environments. In order to ensure your Userful deployment is as smooth and reliable as possible, you need the following:
  
Userful zero clients are extremely bandwidth intensive devices and their deployment requires planning before implementation.
+
<br>
 +
==Certified PC/Server==
  
* '''The Userful host and its zero clients should be placed on their own subnet. A router or a second network interface card can be configured in the Userful host to allow Userful to create and manage its own completely isolated LAN when connected to its own dedicated switch'''
+
Userful recommends business workstation-type hardware from major vendors such as HP, Lenovo and Dell. These systems have the ideal mix of availability, reliability, affordability, and expandability to leverage the advantages of Userful to their fullest. Userful can provide you with a pre-configured PC/Server ready to meet your needs at an affordable cost. Contact a Userful Sales representative for information, and see [[Docs/System Hardware Guide#Certified PCs | Certified PCs]] for our list of recommended systems and accessories.
* No more than 30 zero clients should share the same subnet if they do not uplink to the Userful host with a 10Gbps connection
+
* For optimal performance and reliability, the Userful host(s) and the zero clients should be configured with static IPs
+
  
<br><br>
+
<br>
 +
==Network Preparation==
 +
<onlyinclude>
 +
[[File:Network_Setup_Isolated_LAN.png|thumb|right|450px|An example of a recommended Userful network setup.]]
 +
It is highly recommended that a member of your staff or a contracted professional have CompTIA Network+ certification, or equivalent knowledge and experience when installing Userful systems. For a primer on the knowledge you will need to deploy Userful successfully, please see [[Docs/Network Basics for Userful | Network Basics for Userful]].
  
{|{{Notes}}
+
Userful Zero Client Receivers are IP-based devices and are highly sensitive to network conditions. For proper performance and system stability, the following conditions must be met for the connection between the Userful PC/Server and all Zero Client Receivers:
|
+
*'''Recommended''' Bandwidth to each receiver device: a 1Gbps drop to each zero-client receiver is recommended for video streaming applications, however actual bandwidth used depends on the content and required frame rate. If you have legacy 10/100 network be sure to validate your use case prior to deployment.
'''Note:''' The Userful system should '''NEVER''' share a subnet with WiFi or other network devices that are not critical to the functionality of Userful.<br>
+
*'''Minimum''' Bandwidth to the server of 1000Mbps (1Gbps) for up to 20 displays @ 30fps, or 10,000Mbps (10Gbps) for 20+ displays
|}
+
*'''Maximum''' Latency of 0.500ms - one half of one millisecond
 +
*'''Maximum''' packetloss of 0.001%
 +
*'''Maximum''' number of clients on a 1Gbps subnet is 25 (10Gbps needed for more)
 +
*'''Must''' reside on the same subnet (virtual or physical) as the adapter in the Userful PC/Server (talk with Userful if cross subnet communication between server and client is a requirement for your project)
 +
*'''Recommended''' that Zero Client Receivers be separated from other network devices.
  
<br clear="all"/>
+
The above conditions are easily met with most business- or enterprise-grade gigabit network switches, even inexpensive unmanaged devices work well.
  
==Install==
+
All Userful certified systems come equipped with two network interfaces. One interface is intended to be used to connect to the local network and/or Internet. Another interface should be used exclusively to connect to the Zero Client Receivers through a dedicated switch or VLAN.
Before installing Userful&trade; software appliance please make sure to remove WiFi card from the system or disable any wireless device while configuring system's BIOS as it may prevent the installation of Userful&trade;.  
+
</onlyinclude>
[[Image:Installation_Summary.png|thumb|560px|right|Installation Process]]
+
<br>
<ol start ="1">
+
<li>If you are installing a [[Docs/Supported Capture Cards |capture card]], open the computer and install it into any available PCIe slot </li>
+
<li>Insert the Userful install media into the computer and configure your BIOS to boot from it. While you are in the BIOS:</li>
+
* if you intend to use VDI desktops, ensure virtualization support and/or acceleration options are enabled
+
* if you intend to install the product from USB Flash drive, ensure that UEFI Boot Order is disabled
+
<li> Proceed through the [[Docs/Installation_Guide | installation process]]. Note that the default installation process '''will erase the contents of the hard drive''' and replace it entirely with Userful </li>
+
<li> Upon completion of the install, remove the install media from the host and allow it to restart </li>
+
<li> After first boot, complete the "Initial Setup" process to launch the "Welcome Screen" </li>
+
<li> Make a note of the user name and password created during this process </li>
+
</ol>
+
<br><br>
+
<!--
+
{|{{Notes}}
+
|
+
'''Please Note:''' If you are planning to deploy VDI desktops, you must create additional user accounts other than the root user. However this is not required for video wall setups.<br>
+
|}
+
-->
+
<br clear="all"/>
+
  
==Initial Configuration==
+
==Zero Client Receivers==
  
<!--[[Image:System_Operations.png|thumb|500px|right|System Operations]]-->
+
Each display must have one Zero Client Receiver assigned to it. They can be mounted in any way you see fit - to the display, the wall behind the display, or up to 50ft away (maximum length of an HDMI cable).
After the Initial setup, before connecting any zero clients, the following steps are recommended.
+
  
# Ensure you are able to log into the Linux Desktop session from the default Welcome Screen, then log out again
+
See [[Docs/Supported Zero Client Devices| Supported Zero Client Receivers]] for a list of supported receivers.
# From the Welcome Screen, enter the [[Docs/Control Center |Control Center]] by clicking the "gear" icon in the lower-right corner. Use your account password set during install to access the Control Center
+
# From the Control Center, note and address any pop-up warnings that appear
+
# Check for and install any available updates by going to <tt> Settings > Check for System Updates </tt>
+
# Configure a static IP for the Userful host by going to <tt> Settings > Network Settings </tt>
+
# If you are using a Blackmagic capture card, see [[Docs/FAQs/Capture and Playback#Q:_How_can_I_update_firmware_for_the_Blackmagic_Capture_Card.3F | the FAQs]] for information on how to check for and apply firmware updates
+
  
At this point you should ensure you are able to access the Control Center via a browser on the network by entering the IP address of the Userful host into the browser's address bar. This is the preferred method of managing Userful. Once you have confirmed this, you may disconnect the peripherals attached to the host.
 
  
 +
=Setup Guide=
  
==Zero Clients==
+
The Userful [https://userful.box.com/s/vhip3do34pppq0pcivdp7paummgn07ua Setup Manual] is a printable PDF included with all systems shipped from Userful, and can be used as documentation for most Userful hardware setups.
<!--[[Image:Network_stations.png|thumb|500px|right|Managing Displays]]-->
+
Set up and connect your zero clients in any way you see fit. It is highly recommended that they be fastened to the backs of the displays and powered using VESA mount screws and brackets, for '''any''' type of deployment to avoid unintentional damage to the client.
+
  
 +
'''Once you have completed the setup process outlined in those guides, proceed to [[Docs/Control_Center | Control Center]] to begin managing your new Userful system.'''
  
{|{{Notes}}
 
|
 
'''Please Note:''' Use native connections where possible from the zero client to the relevant peripherals to minimize the risk of issues with automatic screen resolution detection.<br>
 
|}
 
  
 +
==Checklist==
  
When you are ready, power on the zero clients and connect them to the network.
+
Before beginning, ensure you have all the necessary components.
  
Once all the clients are online, go to the "[[Docs/Managing_Displays |Displays]]" section of the Control Center. The most efficient process to make a zero client operational is as follows:
+
* A [[Docs/System_Hardware_Guide#Certified_PCs | certified or compatible computer]] to act as the Userful Server, with temporary monitor, keyboard and mouse for installation and initial configuration.
 
+
* A copy of the [http://www.userful.com/videowall-download-form latest version of Userful software].
# Assign static IPs to each zero client
+
* Your Userful software license key.
# Apply any firmware updates necessary
+
* A compatible [[Docs/Nvidia_Offload_Support#Supported_Cards | Nvidia offload card]] is recommended.
# Name each zero client as you see fit ("display_##", "top left", "3rd from right")
+
* If applicable, a compatible [[Docs/Supported_Capture_Cards | capture card]] for video walls. For more details about Blackmagic capture cards, please visit [[Docs/HowTos/Configure_Blackmagic_DeckLink_Capture_Cards| How to configure Blackmagic capture cards]].
# Finally, assign to the Userful host
+
* One compatible [[Docs/Supported_Zero_Client_Devices | Zero Client Receiver]] for each display. Note that Userful bundles a compatible Zero Client Receiver with each software license purchased.
 +
* Necessary accessories for each Zero Client Receiver - keyboard, mouse, display.
 +
* Networking equipment sufficient to meet requirements outlined above.
 +
* A router or gateway if necessary.
 +
* A network switch with sufficient ports to deliver 1Gbps connectivity to each Zero Client Receiver, and at least 1Gbps to the Userful server.
 +
** A 10Gbps uplink (between Userful server and switch) is recommended if the Userful server will be serving more than 25 displays concurrently.
 +
<!--
 +
::'''Note:''' Ideally an '''unmanaged''' Gigabit switch should be used for network configuration. If you are using a managed switch, it should be configured to perform only the basic switching functionality
 +
-->
 +
* Category-5e or better Ethernet cabling throughout is recommended. Category-6a or SFP is recommended for 10Gbps uplinks.
 +
* Userful '''strongly recommends''' an internet connection for easier access to Userful Support, sharing files, or streaming content from CMS.
 +
<br>
  
 +
Once the components are ready, refer to [[Docs/Setup_Guide#Network_Preparation |Network Preparation]] section for the network guidelines.
  
 
==Install Complete==
 
==Install Complete==
Line 136: Line 100:
 
==Related Links==
 
==Related Links==
 
* [[Docs/System_Hardware_Guide#Certified_PCs | Certified PCs]]
 
* [[Docs/System_Hardware_Guide#Certified_PCs | Certified PCs]]
 +
* [[Docs/HowTos/Change_BIOS_Settings| How to configure BIOS settings]]
 +
* [[Docs/Installation Guide |Installation Guide]]
 +
* [[Docs/Network_Requirements_for_Userful_Appliance | Network Requirements for Userful Appliance]]
 +
* [[Docs/Control Center |Control Center]]
 
* [[Docs/Supported_Capture_Cards | Supported Capture Cards]]
 
* [[Docs/Supported_Capture_Cards | Supported Capture Cards]]
 +
* [[Docs/HowTos/Configure_Blackmagic_DeckLink_Capture_Cards | How To Configure Blackmagic Capture Cards]]
 
* [[Docs/Supported Zero Client Devices| Supported Zero Clients]]
 
* [[Docs/Supported Zero Client Devices| Supported Zero Clients]]
* [[Docs/Installation Guide |Installation Guide]]
 
* [[Docs/Control Center |Control Center]]
 
 
* [[Docs/Mapping |Mapping Guide]]
 
* [[Docs/Mapping |Mapping Guide]]
 
* [[Docs/Configuring Video Wall |Configuring Video Wall]]
 
* [[Docs/Configuring Video Wall |Configuring Video Wall]]
 
* [[Docs/FAQs |Frequently Asked Questions]]
 
* [[Docs/FAQs |Frequently Asked Questions]]
 +
* [https://www.userful.com/videowall Video Wall Solutions Page]
 +
 
<noinclude>
 
<noinclude>
 
{{forcewhitespace}}
 
{{forcewhitespace}}
 
[[Category:Docs]]
 
[[Category:Docs]]
 
</noinclude>
 
</noinclude>

Latest revision as of 17:06, 19 October 2018


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

To return to the main documentation page, Click Here.


Introduction

This page will walk you through setting up your Userful appliance and network zero client receivers. Please read it entirely before beginning, and ensure you have all the prerequisite components.

Please watch this video to know about basic requirements and steps for installing Userful™ software appliance and for quick tour of Userful Control Center.

Prerequisites for Userful

Userful is a powerful, flexible solution for delivering video walls and digital signage in many environments. In order to ensure your Userful deployment is as smooth and reliable as possible, you need the following:


Certified PC/Server

Userful recommends business workstation-type hardware from major vendors such as HP, Lenovo and Dell. These systems have the ideal mix of availability, reliability, affordability, and expandability to leverage the advantages of Userful to their fullest. Userful can provide you with a pre-configured PC/Server ready to meet your needs at an affordable cost. Contact a Userful Sales representative for information, and see Certified PCs for our list of recommended systems and accessories.


Network Preparation

An example of a recommended Userful network setup.

It is highly recommended that a member of your staff or a contracted professional have CompTIA Network+ certification, or equivalent knowledge and experience when installing Userful systems. For a primer on the knowledge you will need to deploy Userful successfully, please see Network Basics for Userful.

Userful Zero Client Receivers are IP-based devices and are highly sensitive to network conditions. For proper performance and system stability, the following conditions must be met for the connection between the Userful PC/Server and all Zero Client Receivers:

  • Recommended Bandwidth to each receiver device: a 1Gbps drop to each zero-client receiver is recommended for video streaming applications, however actual bandwidth used depends on the content and required frame rate. If you have legacy 10/100 network be sure to validate your use case prior to deployment.
  • Minimum Bandwidth to the server of 1000Mbps (1Gbps) for up to 20 displays @ 30fps, or 10,000Mbps (10Gbps) for 20+ displays
  • Maximum Latency of 0.500ms - one half of one millisecond
  • Maximum packetloss of 0.001%
  • Maximum number of clients on a 1Gbps subnet is 25 (10Gbps needed for more)
  • Must reside on the same subnet (virtual or physical) as the adapter in the Userful PC/Server (talk with Userful if cross subnet communication between server and client is a requirement for your project)
  • Recommended that Zero Client Receivers be separated from other network devices.

The above conditions are easily met with most business- or enterprise-grade gigabit network switches, even inexpensive unmanaged devices work well.

All Userful certified systems come equipped with two network interfaces. One interface is intended to be used to connect to the local network and/or Internet. Another interface should be used exclusively to connect to the Zero Client Receivers through a dedicated switch or VLAN.


Zero Client Receivers

Each display must have one Zero Client Receiver assigned to it. They can be mounted in any way you see fit - to the display, the wall behind the display, or up to 50ft away (maximum length of an HDMI cable).

See Supported Zero Client Receivers for a list of supported receivers.


Setup Guide

The Userful Setup Manual is a printable PDF included with all systems shipped from Userful, and can be used as documentation for most Userful hardware setups.

Once you have completed the setup process outlined in those guides, proceed to Control Center to begin managing your new Userful system.


Checklist

Before beginning, ensure you have all the necessary components.

  • A certified or compatible computer to act as the Userful Server, with temporary monitor, keyboard and mouse for installation and initial configuration.
  • A copy of the latest version of Userful software.
  • Your Userful software license key.
  • A compatible Nvidia offload card is recommended.
  • If applicable, a compatible capture card for video walls. For more details about Blackmagic capture cards, please visit How to configure Blackmagic capture cards.
  • One compatible Zero Client Receiver for each display. Note that Userful bundles a compatible Zero Client Receiver with each software license purchased.
  • Necessary accessories for each Zero Client Receiver - keyboard, mouse, display.
  • Networking equipment sufficient to meet requirements outlined above.
  • A router or gateway if necessary.
  • A network switch with sufficient ports to deliver 1Gbps connectivity to each Zero Client Receiver, and at least 1Gbps to the Userful server.
    • A 10Gbps uplink (between Userful server and switch) is recommended if the Userful server will be serving more than 25 displays concurrently.
  • Category-5e or better Ethernet cabling throughout is recommended. Category-6a or SFP is recommended for 10Gbps uplinks.
  • Userful strongly recommends an internet connection for easier access to Userful Support, sharing files, or streaming content from CMS.


Once the components are ready, refer to Network Preparation section for the network guidelines.

Install Complete

Proceed to Control Center to begin managing your new Userful system.

Related Links