Note

You are viewing the documentation for an older release of Interworx (6.x). To see documentation for the current generally available release of Interworx, click here: 7.13.

How to: Activate InterWorx Control Panel License

Warning

Activating an InterWorx license, either via the web browser or the command line, can only be attempted once on a server. It is highly recommended to take a snapshot of the server before attempting to activate the license.

If there is an error when activating the license, the server can be reverted to the snapshot. Otherwise, starting over completely from a fresh OS install would be required.

Prerequisites

Note

Running the InterWorx license activation script within a Linux screen session is recommended. Screen creates a shell session that continues to stay active, even if there is network disruption. Detailed information on using screen can be found here.

To determine whether screen is installed on the system, run which screen. If screen is installed, the system will return /usr/bin/screen

If screen is not already installed, it can be installed by running yum install screen

To install InterWorx from within a screen session, type the word screen  at the command line. Then, run the InterWorx installation command.

If the session disconnects, log back in at the command line and typescreen -r. This will reconnect the screen session.

Interactive Activation

Using the interactive activation script, users will be prompted to submit the InterWorx License Key, as well as the email and password to be used for the master NodeWorx account.

  1. Log into the server at the command line as the root user via SSH

  2. Run the goiworx.pex script:

    root@server# cd /usr/local/interworx/bin
root@server# ./goiworx.pex

  3. When prompted, enter the InterWorx License Key:

    +----------------------------------------------------------------------+
| Go! InterWorx |
+----------------------------------------------------------------------+
+----------------------------------------------------------------------+
| License Key Setup |
+----------------------------------------------------------------------+
 Please enter license key: INTERWORX_XXXXXXXXXX
 You entered 'INTERWORX_XXXXXXXXXX'.

  4. When prompted, enter the email and password to be used for the master NodeWorx user. This is the administrator account for the InterWorx Control Panel

    +----------------------------------------------------------------------+
| Default NodeWorx User Setup |
+----------------------------------------------------------------------+
e-mail address: admin@yourbox.com
password: your-password
confirm : your-password

  5. Once the goiworx scripts ends, login to NodeWorx by navigating to https://[ip.ad.re.ss]:2443/nodeworx/, using the e-mail address and password set up in the previous step

Scripted Activation

The activation script can also be run in non-interactive mode.

  1. Log into the server at the command line as the root user via SSH

  2. Run the goiworx.pex script with the following parameters:

~iworx/bin/goiworx.pex --key=LICENSE_KEY --email=EMAIL --password=PASSWORD --ignorechecks

Note

Make sure the above is all one line. Replace LICENSE_KEY, EMAIL, and PASSWORD

Troubleshooting

  • If license activation errors occur:

    • Make sure that the server time is correct

    • Make sure that license.interworx.com is resolvable and pingable from the server

  • When moving a license key from one server to another, the IP of the license key must be reset in the billing portal

    • Instructions on how to change the binding IP for an InterWorx License Key can be found here

  • Verify that port 2443 is open both out and inbound to the server