StarQuest Technical Documents

Quick Start Guide to Using StarLicense for UNIX

Last Update: 5 October 2017
Product: StarLicense for UNIX
Version: 1.2x or later
Article ID: SQV00SL005

Abstract

This Quick Start Guide describes how to install, configure, and use the StarLicense software on a UNIX or Linux computer. Read the complete document before starting your installation.

This document is intended for first-time users of StarLicense. Users who are upgrading an existing installation should refer to the Release Notes and the StarLicense User's Guide for upgrade instructions.

The estimated time to complete all tasks is approximately 40 minutes.

StarLicense for UNIX Quick Start Guide Outline

The installation and configuration of StarLicense for UNIX requires the authority of a System Administrator. This is someone with authority to install the StarLicense software on a platform that is accessible to the computer to be used in conjunction with StarSQL. This user typically must be a root user on the UNIX platform.

General considerations

  • The StarLicense Server Platform can be the same or a different platform as the StarSQL Client Platform. In the latter case, the StarLicense Server Platform must be on the same network as the Client Platform.
  • StarLicense listens for StarSQL licensing requests on port 4999, by default. If this computer is protected by a firewall, open port 4999 to allow incoming requests. Alternatively, modify the StarLicense software to listen on a port that is already open. Configuring the StarLicense listening port will be addressed in this document.

Summary of tasks

  1. Request to download StarLicense for UNIX.
  2. Receive the e-mail with a Registration Key and the download link for the StarLicense component.
  3. Download StarLicense using the download link from step 2 and install the software.
  4. License the StarLicense software using the registration key in the download confirmation e-mail (from step 2).
  5. Test licensing checkout.
  6. License the StarSQL client.

Step 1: Request StarLicense Software

Estimated Time: 5 minutes

All software packages are distributed as compressed files that you download from the StarQuest Ventures Web site. From a web browser enter the address http://www.starquest.com/ and click on Download for Trial under the Products menu. Request to download StarSQL for the platform of interest (i.e., Linux, Solaris, HP-UX, etc.) as StarLicense will automatically be provided when this request is fulfilled.

Step 2: Receive the Download Confirmation E-mail from StarQuest

Estimated Time: Less than 5 minutes

After submitting a request to download StarSQL for UNIX, you will receive an e-mail containing a download link for StarLicense and a Registration Key. The download link will be used in step 3 and the Registration Key will be used in step 4 to obtain a temporary license valid for 15 days.

Step 3: Download and Install StarLicense

Estimated Time: 10 minutes

The user who installs StarLicense must be a root user on the platform.

  1. Download StarLicense for UNIX using the download link from step 2.
  2. Uncompress the downloaded file using the uncompress <filename> command, as shown in the following example.

    # uncompress starlicense-linux.tar.Z

  3. Extract the files from the archive to a temporary directory using the tar -options <filename> command, as shown in the following examples.

    # tar -xvf starlicense-linux.tar

    or

    # tar -xvf starlicense-linux-rpm.tar

  4. From the temporary directory that contains the StarLicense installation source files, run the setup script to start the installation. If you are using a Mac OS X computer, run the setupmacos.command. The installation process installs the StarLicense software into the default directory shown in the following table for each supported platform.
Platform Default StarLicense Installation Directory
AIX /usr/lpp/starlicense
FreeBSD /usr/local/share/starlicense
HP-UX /opt/starlicense
Linux /usr/share/starlicense
Mac OS X /Applications/starlicense
Solaris /opt/starlicense

As the setup script runs you must respond to various prompts and reminders, answering y (Yes) to proceed with the installation. Following is an example of the prompts and responses for running the script on a Linux computer.

# ./setup

This script uses rpm to install StarLicense for UNIX to /usr/share/starlicense and should be run as root.

Do you wish to continue (y/n)? y

When the installation completes, a prompt appears that asks if you want to administer the StarLicense server.

  • Answer n (No) if you do not have the Registration Key from step 2 or are not prepared to license the software. After the installation completes, you can administer the StarLicense server at a later time by running configure from the StarLicense installation directory.
  • Answer y (Yes) if you have the Registration Key from step 2 and are prepared to license the software. Proceed to step 4.

Step 4: License the StarLicense Software

Estimated Time: 10 minutes

You will need the Registration Key from step 2 to license the software, and the user who administers StarLicense must be a root user on the platform.

If you opted to administer StarLicense after the installation, you will be presented with the StarLicense Configuration Menu. Or, run configure from the StarLicense installation directory to display the StarLicense Configuration Menu. The StarLicense Configuration Menu presents the following options:


StarLicense Configuration Menu

1) Add license with Registration Key (via Internet)
2) Add license with License Key
3) Remove a License Key

4) Start License Server daemon
5) Stop License Server daemon
6) Display License Server status
7) Test licensing checkout
8) Display StarLicense configuration

9) Configure local StarLicense client to use a License Server
10) Remove a client-server connection from local StarLicense configuration

11) Licensing Help
12) Exit

If the computer running StarLicense has access to the Internet, follow the Online Licensing Instructions below. Otherwise, follow the Alternate Licensing Instructions.

Online Licensing Instructions

  1. Select option 1) Add license with Registration Key (via Internet).
  2. If you want to license this particular computer, answer yes (y) to the prompt. If you want to license a different computer, follow the Alternate Licensing Instructions below.
  3. Enter the Registration Key provided in the download confirmation e-mail and press Return. StarLicense connects to the StarQuest licensing server to obtain a license key. If the request fails, correct the error and retry or use the Alternate Licensing Instructions below.
  4. After a license key is obtained, a Listener is configured. Enter the IP address that StarLicense should listen on. If you want StarLicense to listen on all configured IP addresses, leave this field blank. Press Return.
  5. Enter the port number that you want StarLicense to listen on for licensing requests. If there is an existing port open in the firewall that you want StarLicense to use, enter this port number now. If the default port, 4999, is acceptable, leave this field blank. Press Return.

Alternate Licensing Instructions

  1. From a computer that has access to the Internet, click on or browse to the following URL:

    http://starcust.starquest.com/Registration/index.html#license

  2. On the StarQuest Online Licensing Form web page, enter in the e-mail address used for the original download request and the Registration Key you received in the download confirmation e-mail.
  3. Enter the IP address of the computer where StarLicense is installed. If the computer has multiple IP addresses configured, any one of the IP addresses can be used. Enter the address in decimal dot notation (e.g., 192.168.44.12).
  4. Select the License Server radio button. Click Next.
  5. Review the information provided. If any changes are required, click Previous and modify the values as needed. Otherwise, click the Accept button.
  6. Copy the license key to the clipboard. You will also receive an e-mail with the license key.
  7. From the StarLicense Configuration Menu, choose option 2) Add license with License Key.
  8. Enter or paste in the license key obtained previously and press Return.
  9. After a license key has been entered, a Listener is configured. Enter the IP address that StarLicense should listen on. If you want StarLicense to listen on all configured IP addresses, leave this field blank. Press Return.
  10. Enter the port number that you want StarLicense to listen on for licensing requests. If there is an existing port open in the firewall that you want StarLicense to use, enter this port number now. If the default port, 4999, is acceptable, leave this field blank. Press Return.

Step 5: Start the Server & Test Licensing Checkout

Estimated Time: Less than 5 minutes

The user who administers StarLicense must be a root user on the platform.

  1. Run configure from the StarLicense installation directory to display the StarLicense Configuration Menu.
  2. Select option 4) Start License Server daemon
  3. Select option 7) Test licensing checkout.
  4. Enter the number of licenses to check out (which should not exceed the number of provided by the license key) and press Return.
  5. After the licenses have been checked out successfully, press Return to check in the licenses. Press the Return key to return to the main menu.
  6. Choose option 12 to exit the StarLicense Client Configuration Menu.

Step 6: License the StarSQL Client

Estimated Time: Less than 5 minutes

StarSQL is designed to look first on the local computer for a license and if none is found, attempt to connect to a StarLicense server named starlic that is listening for license requests on communications port 4999. To avoid the need to configure each StarSQL client with the location of the StarLicense server, add a DSN entry on the network for starlic that points to the StarLicense server.

If you prefer to explicitly configure each StarSQL client with the location of the license server, provide the StarSQL Client-Platform Administrator with the following client license configuration information:

  • The Network host name or IP address of the StarLicense server.
  • The port number on which StarLicense is configured to listen for licensing requests, the default is 4999.
  • The Product ID (ProdID) specified by the license.

If you are unsure of the values, run configure from the StarLicense installation directory to display the StarLicense Configuration Menu and choose option 8) Display StarLicense Configuration. Review the Server and Listener configurations.

Continuing Your Software Evaluation

This Quick Start Guide is intended to help you install the StarQuest software and access DB2 data as quickly as possible.

As you use the StarLicense software, refer to the product documentation for more information. StarLicense includes man pages, Release Notes and a User's Guide that provide more information about StarLicense usage.

If you encounter any problems while using the evaluation software, please open a problem report with StarQuest Customer Support at http://support.starquest.com or call +1 415.669.9619 for assistance.

Additional References

StarLicense man pages
StarLicense for UNIX Release Notes
StarLicense for UNIX User's Guide

Tehcnical Documents
How to Add the StarLicense for UNIX Daemon to the Boot Process
Configuring TCP KeepAlive Parameters


DISCLAIMER

The information in technical documents comes without any warranty or applicability for a specific purpose. The author(s) or distributor(s) will not accept responsibility for any damage incurred directly or indirectly through use of the information contained in these documents. The instructions may need to be modified to be appropriate for the hardware and software that has been installed and configured within a particular organization.  The information in technical documents should be considered only as an example and may include information from various sources, including IBM, Microsoft, and other organizations.