How To/UMx/Install OEM License Keys

From Userful Support

Jump to: navigation, search

Userful Multiplier License Installation for OEMs



Copyright © 2008 Userful Corporation. All rights reserved.
(Updated 2008.07.07)


Contents

Introduction

This document presents two methods for OEMs of Userful Multiplier product to prepare multi-station PC systems for volume licensing. Volume licensing must be set up with your Userful representative prior to preparing PC systems for volume licensing.

Activation Code Pre-Installation Method

Introduction

Pre-installing an activation code on a common installation disk image allows Userful Multiplier to be installed by the OEM on a multi-station PC system, but automatically licensed on first boot at the Internet-enabled customer site. This method is recommended when deploying more than 10 multi-station PC systems at once.

Instructions

  1. Log in to the Userful Licensing Portal at https://store.userful.com/reseller.
  2. Select a Contract Number for use with the activation group.
  3. Create a New Group for a shared activation code. Be sure you check "share activation code" when generating the licenses.
  4. Create an installation disk image containing your installed Linux operating system, installed applications, etc.
  5. Install Userful Multiplier to the installation disk image, but do not attempt to license it.
  6. Create a file on the installation disk image containing the activation code to be supplied from the Userful Licensing Server. A suggested location is /etc/OEM-activation-code
  7. Configure the Linux system, at each boot up, to try to retrieve a license key if one does not already exist, by adding the following command to /etc/rc.local, or to the appropriate startup script /usr/share/1box-utils/install-license.sh -f /etc/OEM-activation-code -n -D

Note for security purposes, use the -D option to automatically delete the /etc/OEM-activation-code file after the license key is successfully retrieved and installed. The -D option is available on Userful Multiplier version >= 3.0-13.beta. For more information on how to use the install-license.sh script, use the -h option.

License Pre-Installation Method

Introduction

Pre-installing Userful Multiplier licenses is required if the deployment site is not Internet-enabled, or if the size or nature of the deployment preclude the use of a pre-installed activation code on a disk image.

Instructions

Userful Licensing Portal Setup

  1. Create an OEM master file to be distributed to all multi-station computers on which Userful Multiplier will be licensed. The contents of this file are used to create the OEM specific hash. The contents can include any text, but we suggest standardizing on including the OEM name and address, the project number, and any other project notes. The licensing server does not read the contents of the OEM master file but only uses the hash generated against the OEM master file as the unique identifier.
  2. Run "sha1sum /etc/userful/oem" to obtain a hash of the file. The hash is the OEM Number and will be supplied to the Userful Licensing Portal.
  3. Copy the OEM master file, and the output from the sha1sum hash, to removable media. The OEM master file will need to be copied to all multi-station computers to be licensed under this OEM Number.
  4. Log in to the Userful Licensing Portal at https://store.userful.com/reseller.
  5. Select a Contract Number for use with this project.
  6. Create a New Group with the set of IP Addresses for this project which will use use the OEM Number obtained in step 2, above.
  7. Copy and paste the OEM Number from step 2 into the OEM Number field.
  8. Input a comma-separated list of addresses into the IP Addresses field. This must be the external-facing IP address(es) from which multi-station computers will communicate with the Userful licensing server to obtain licenses. These are usually the addresses of the firewalls or the router IP addresses connecting directly to the Internet. The IP Addresses cannot be internal address such as 10.10.2.41 or 192.168.11.12.
  9. Complete the remainder of the form, then click Add.

Note: Multiple projects can be created and used under the same Contract Number, but each project requires a unique OEM Number.

Multi-Station Computer Setup

  1. Make the OEM master file accessible (from a floppy disk, USB key, network share, or the hard disk) when a multi-station computer boots for the first time after installing Userful Multiplier and not have a license.
  2. The OEM master file, which generates the correct OEM hash through sha1sum, must be copied to /etc/userful/oem on each multi-station system to be licensed.
  3. Connect the machine to be licensed to the Internet and turns it on or reboots.
  4. The first file to execute when the Userful Multiplier runs is /usr/share/1box-utils/install-license.sh. This will connect the multi-station computer to the Userful Licensing Portal. If both the OEM number and IP address match a project in the Userful Licensing Portal, a license file will be downloaded and installed, and the appropriate number of stations will be extracted from the contract. If the OEM number or IP address are not known or do not match, no license file will be downloaded.

Note: The install-license.sh script can be configured to search a different path for the OEM file by changing the line OEMFILE=/etc/userful/oem (line 118) to refer to a different location, such as a floppy disk, a CD or flash drive. If the OEMFILE location is set to removable storage, be sure to properly mount the removable storage device in the boot process before install-license.sh runs.

How the boot up process works

The first time the computer is booted after Userful multi-station software is installed, the Userful configuration utility invokes install-license.sh, which searches for a file at OEMFILE, which is located at /etc/userful/oem. Partners may customize the file path, for example, to point to a floppy, USB drive, CD or network file system, by mounting the appropriate path and changing the OEMFILE parameter in /usr/share/1box-utils/install-license.sh.

The file at OEMFILE is supplied by Userful or its partners and contains information specific to the OEM, including an OEM Number, Project Number and a list of valid IP addresses or ranges from which the OEM may automatically obtain licenses. The files may not be altered by the OEM, however, an OEM may use any valid OEMFILE issued to them.

An OEM deploying many multi-station computers at once may choose to deplete licenses from any of their project numbers, which will be updated by the store.





Personal tools