License Server Quick Start: Difference between revisions
imported>Jeremy No edit summary |
|||
(42 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
Follow the steps below to install and use a floating license of an Eigenvector Research product | __TOC__ | ||
Follow the steps below to install and use a floating license of an Eigenvector Research product. These licenses use the [[Evri_license_server| EVRI License Server (click for more information)]]. | |||
===Downloading Files=== | |||
1) Download these three items: | 1) Download these three items: | ||
:a) The [ | :a) The [https://www.software.eigenvector.com/toolbox/license_server/EVRILicenseServer.zip license server application] (license server ZIP) | ||
:b) A copy of the software product (e.g. PLS_Toolbox, Solo, Solo+MIA) - these are available from [http://download.eigenvector.com/?tab=1 your account's Downloads tab]. (application installer) | :b) A copy of the software product (e.g. PLS_Toolbox, Solo, Solo+MIA) - these are available from [http://download.eigenvector.com/?tab=1 your account's Downloads tab]. (application installer) | ||
:c) The license files available from [http://download.eigenvector.com/?tab=3 your account's "Other Files" tab] (license files ZIP). | :c) The license files available from [http://download.eigenvector.com/?tab=3 your account's "Other Files" tab] (license files ZIP). | ||
Line 8: | Line 12: | ||
===On the computer which will run the license server=== | ===On the computer which will run the license server=== | ||
2) Extract the license server ZIP (downloaded in 1a) onto the server computer (all computers, clients and server must be connected by a network) | 2) Extract the license server ZIP (downloaded in 1a) onto the server computer (all computers, clients and server must be connected by a network). You can extract the ZIP file into any folder location where you have permission to write to. | ||
3) Copy the ''evriserverlicense. | 3) Copy the ''evriserverlicense.xml'' from the license files ZIP (downloaded in step 1c) into the same folder as the ''EVRILicenseServer.jar'' file (the main folder created when the license server was unzipped). | ||
4) Double-click the ''EVRILicenseServer.jar'' file to start up the server | 4) Double-click the ''EVRILicenseServer.jar'' file to start up the server | ||
* ''For other configuration and start-up options, see [[Evri_license_server#Server_Configuration | Server Configuration]] | * ''For other configuration and start-up options, see [[Evri_license_server#Server_Configuration | Server Configuration]] | ||
Note: The computer selected to run the license server can not also run the client application (i.e. the Eigenvector product being licensed - PLS_Toolbox, Solo, etc). As such, the computer you select to run the license server must: | |||
:Be reachable by network | |||
:Be identified by its network name or by a static (fixed) IP address | |||
:'''Not be a computer on which you want to run the client application''' | |||
Also, this computer must have Java (version 1.6 or later) installed since the license server is a Java program. See the first Troubleshooting tip below for instructions on how to check if Java is installed. | |||
===On each client computer=== | ===On each client computer=== | ||
5) Run the application installer downloaded in step 1b (when asked for a license code, choose "Cancel", this will cause the installer to abort. The last step of installation will be done later) | 5) Run the application installer downloaded in step 1b (when asked for a license code, choose "Cancel", this will cause the installer to abort. The last step of installation will be done later). | ||
Note, if you downloaded PLS_Toolbox as a .ZIP file then decompress the PLS_Toolbox ZIP file and move it to the MATLAB "toolbox" folder (e.g. C:\Program Files\MATLAB\R2019a\toolbox). If you already have a version of PLS_Toolbox installed, be sure the folders do not have the same name (by default they should not). Rename your existing copy of PLS_Toolbox if necessary. | |||
6) Edit the ''evrilm.xml'' file (located in the license files ZIP downloaded in step 1c). Edit ONLY the segment of the file specifying the server address: | 6) Edit the ''evrilm.xml'' file (located in the license files ZIP downloaded in step 1c). Edit ONLY the segment of the file specifying the server address: | ||
Line 26: | Line 39: | ||
7) Install the ''evrilm.xml'', ''evrilicense.lic'', and ''evrinetwork.lic'' files from the license files ZIP onto the client: | 7) Install the ''evrilm.xml'', ''evrilicense.lic'', and ''evrinetwork.lic'' files from the license files ZIP onto the client: | ||
:* '''For Matlab-based products''' (e.g. PLS_Toolbox) copy the files into the "utilities" folder of the product installed in step 4 (usually the Toolbox/{product_name} folder inside the Matlab folder) | :* '''For Matlab-based products''' (e.g. PLS_Toolbox) copy the files into the "utilities" folder of the product installed in step 4 (usually the Toolbox/{product_name} folder inside the Matlab folder) | ||
:* '''For stand-alone products''' (e.g. Solo, Solo+MIA, Solo_Predictor), copy the files into the | :* '''For stand-alone products''' (e.g. Solo, Solo+MIA, Solo_Predictor), copy the files into the folder where the .exe file resides (usually located in C:\Program Files\EVRI\{product_name} on PCs or similar on other platforms). '''NOTE:''' for Solo based products version 9.0 or newer the location will be similar to C:\Program Files\EVRI\{product_name}\application | ||
8) Finish installation of the product: | 8) Finish installation of the product: | ||
:* '''For Matlab-based products''' | :* '''For Matlab-based products''' | ||
::a) | ::a) Start up Matlab (if not already running) | ||
::b) | ::b) Change the working directory to be the main product folder | ||
::c) | ::c) Type the command: ''evriinstall silent'' in the Matlab command window | ||
:* '''For stand-alone products''' | ::d) Verify installation by typing: ''pls test'' which should return an expiration date (in the future by about 10 minutes) | ||
:* '''For stand-alone products''' | |||
::Start up the application. The license files should be read and automatically configured to run with the server. | |||
=== | ===Updating Client Computers with New Versions=== | ||
When you go through the download process for a newer version of PLS_Toolbox or Solo the website will generate new license files in the Other Files tab for that version. Repeat the steps from "On each client computer" above. New versions of PLS_Toolbox or Solo do NOT generally require any updating to the License Server. | |||
==Troubleshooting== | |||
=== 1. Check Java on Server=== | |||
A common problem can occur when an automatic update of Java does not complete successfully on the server computer. To test Java open a Command Prompt (terminal) on the server computer and run the following command: | |||
<pre>java -version</pre> | |||
If anything other than version information is displayed try reinstalling java. Example output from working java installation: | |||
<pre> | |||
$ java -version | |||
java version "1.6.0_51" | |||
Java(TM) SE Runtime Environment (build 1.6.0_51-b11-457-11M4509) | |||
Java HotSpot(TM) 64-Bit Server VM (build 20.51-b01-457, mixed mode) | |||
</pre> | |||
Java can be downloaded from www.java.com | |||
=== 2. Check the license server=== | |||
For this check and the next check it is helpful to test the license server by starting it manually (double-clicking on the EVRILicenseServer.jar file) as this will open the EVRI License Manager window showing log messages. This window does not appear when the license server is running as a service. | |||
On the license server computer, start up a web browser (Firefox, Chrome, Opera, Internet Explorer, etc.) and go to the URL: | |||
http://127.0.0.1:2212/ | http://127.0.0.1:2212/ | ||
you should receive the response: "-3" (Chrome may instead respond: "This page isn’t working 127.0.0.1 sent an invalid response. ERR_INVALID_HTTP_RESPONSE"), and the EVRI License Manager window should report: "...Request from 127.0.0.1 Refused Loopback". | |||
'''IF NOT''': If the browser did not give one of those responses, or the EVRI License Manager window show the message above, then the server is not running correctly or ''evriserverlicense.xml'' is not valid. Please review the [[Evri_license_server#Server_Configuration | Server Configuration instructions]] and, if the problem is not resolved, send the contents of the server message window to [mailto:helpdesk@eigenvector.com Eigenvector's help desk] | |||
=== 3. Check the network connection=== | |||
On one of the client computers, NOT on the EVRI license server computer, start up a web browser (Firefox, Chrome, Opera, Internet Explorer, etc.) and go to the URL: | |||
http://___IP___:2212/ | http://___IP___:2212/ | ||
replacing "___IP___" with the IP address of the server computer (same one used in step 6). | |||
You should receive the response: "-2" (Chrome may instead respond: This page isn't working ___IP___ sent an invalid response ERR_INVALID_HTTP_RESPONSE), and the EVRI License Manager window should report: "...Request from: /___client_IP___ Bad Access Code". | |||
'''IF NOT''': If the browser did not give one of those responses, or if the EVRI License Manager window does not report having received your HTTP request message, then the server is not reachable from the client computer, check network connection and firewall status. The license server requires the server computer to allow connections on the license server port (default port is 2212). You may need to get help from your local IT support to enable TCP/IP connectivity between your computer and the EVRI license server computer. | |||
'''NOTE''': It is important to test the network connection to the EVRI license server computer by using "http" in this way and NOT by simply using "ping" to this IP address since these two tests are not equivalent. You can get a successful ping return without having a successful http connection. | |||
=== 4. Check the license files=== | |||
If the client application (PLS_Toolbox, Solo, etc.) is responding with an "invalid license" message, verify that the evrilicense.lic file is the one provided by Eigenvector for this license. Delete any evrilicense.lic files you have and re-copy the license files provided. | |||
'''If you still have problems''': [mailto:helpdesk@eigenvector.com contact help desk] to verify that the license file you have is appropriate for the application you are running. Please make sure you provide your evrilicense.lic file. |
Latest revision as of 14:51, 10 September 2024
Follow the steps below to install and use a floating license of an Eigenvector Research product. These licenses use the EVRI License Server (click for more information).
Downloading Files
1) Download these three items:
- a) The license server application (license server ZIP)
- b) A copy of the software product (e.g. PLS_Toolbox, Solo, Solo+MIA) - these are available from your account's Downloads tab. (application installer)
- c) The license files available from your account's "Other Files" tab (license files ZIP).
On the computer which will run the license server
2) Extract the license server ZIP (downloaded in 1a) onto the server computer (all computers, clients and server must be connected by a network). You can extract the ZIP file into any folder location where you have permission to write to.
3) Copy the evriserverlicense.xml from the license files ZIP (downloaded in step 1c) into the same folder as the EVRILicenseServer.jar file (the main folder created when the license server was unzipped).
4) Double-click the EVRILicenseServer.jar file to start up the server
- For other configuration and start-up options, see Server Configuration
Note: The computer selected to run the license server can not also run the client application (i.e. the Eigenvector product being licensed - PLS_Toolbox, Solo, etc). As such, the computer you select to run the license server must:
- Be reachable by network
- Be identified by its network name or by a static (fixed) IP address
- Not be a computer on which you want to run the client application
Also, this computer must have Java (version 1.6 or later) installed since the license server is a Java program. See the first Troubleshooting tip below for instructions on how to check if Java is installed.
On each client computer
5) Run the application installer downloaded in step 1b (when asked for a license code, choose "Cancel", this will cause the installer to abort. The last step of installation will be done later).
Note, if you downloaded PLS_Toolbox as a .ZIP file then decompress the PLS_Toolbox ZIP file and move it to the MATLAB "toolbox" folder (e.g. C:\Program Files\MATLAB\R2019a\toolbox). If you already have a version of PLS_Toolbox installed, be sure the folders do not have the same name (by default they should not). Rename your existing copy of PLS_Toolbox if necessary.
6) Edit the evrilm.xml file (located in the license files ZIP downloaded in step 1c). Edit ONLY the segment of the file specifying the server address: <serveraddress>ip_address</serveraddress>
- replacing ip_address with the IP address or name of the computer running the license server
7) Install the evrilm.xml, evrilicense.lic, and evrinetwork.lic files from the license files ZIP onto the client:
- For Matlab-based products (e.g. PLS_Toolbox) copy the files into the "utilities" folder of the product installed in step 4 (usually the Toolbox/{product_name} folder inside the Matlab folder)
- For stand-alone products (e.g. Solo, Solo+MIA, Solo_Predictor), copy the files into the folder where the .exe file resides (usually located in C:\Program Files\EVRI\{product_name} on PCs or similar on other platforms). NOTE: for Solo based products version 9.0 or newer the location will be similar to C:\Program Files\EVRI\{product_name}\application
8) Finish installation of the product:
- For Matlab-based products
- a) Start up Matlab (if not already running)
- b) Change the working directory to be the main product folder
- c) Type the command: evriinstall silent in the Matlab command window
- d) Verify installation by typing: pls test which should return an expiration date (in the future by about 10 minutes)
- For stand-alone products
- Start up the application. The license files should be read and automatically configured to run with the server.
Updating Client Computers with New Versions
When you go through the download process for a newer version of PLS_Toolbox or Solo the website will generate new license files in the Other Files tab for that version. Repeat the steps from "On each client computer" above. New versions of PLS_Toolbox or Solo do NOT generally require any updating to the License Server.
Troubleshooting
1. Check Java on Server
A common problem can occur when an automatic update of Java does not complete successfully on the server computer. To test Java open a Command Prompt (terminal) on the server computer and run the following command:
java -version
If anything other than version information is displayed try reinstalling java. Example output from working java installation:
$ java -version java version "1.6.0_51" Java(TM) SE Runtime Environment (build 1.6.0_51-b11-457-11M4509) Java HotSpot(TM) 64-Bit Server VM (build 20.51-b01-457, mixed mode)
Java can be downloaded from www.java.com
2. Check the license server
For this check and the next check it is helpful to test the license server by starting it manually (double-clicking on the EVRILicenseServer.jar file) as this will open the EVRI License Manager window showing log messages. This window does not appear when the license server is running as a service.
On the license server computer, start up a web browser (Firefox, Chrome, Opera, Internet Explorer, etc.) and go to the URL:
http://127.0.0.1:2212/
you should receive the response: "-3" (Chrome may instead respond: "This page isn’t working 127.0.0.1 sent an invalid response. ERR_INVALID_HTTP_RESPONSE"), and the EVRI License Manager window should report: "...Request from 127.0.0.1 Refused Loopback".
IF NOT: If the browser did not give one of those responses, or the EVRI License Manager window show the message above, then the server is not running correctly or evriserverlicense.xml is not valid. Please review the Server Configuration instructions and, if the problem is not resolved, send the contents of the server message window to Eigenvector's help desk
3. Check the network connection
On one of the client computers, NOT on the EVRI license server computer, start up a web browser (Firefox, Chrome, Opera, Internet Explorer, etc.) and go to the URL:
http://___IP___:2212/
replacing "___IP___" with the IP address of the server computer (same one used in step 6). You should receive the response: "-2" (Chrome may instead respond: This page isn't working ___IP___ sent an invalid response ERR_INVALID_HTTP_RESPONSE), and the EVRI License Manager window should report: "...Request from: /___client_IP___ Bad Access Code".
IF NOT: If the browser did not give one of those responses, or if the EVRI License Manager window does not report having received your HTTP request message, then the server is not reachable from the client computer, check network connection and firewall status. The license server requires the server computer to allow connections on the license server port (default port is 2212). You may need to get help from your local IT support to enable TCP/IP connectivity between your computer and the EVRI license server computer.
NOTE: It is important to test the network connection to the EVRI license server computer by using "http" in this way and NOT by simply using "ping" to this IP address since these two tests are not equivalent. You can get a successful ping return without having a successful http connection.
4. Check the license files
If the client application (PLS_Toolbox, Solo, etc.) is responding with an "invalid license" message, verify that the evrilicense.lic file is the one provided by Eigenvector for this license. Delete any evrilicense.lic files you have and re-copy the license files provided.
If you still have problems: contact help desk to verify that the license file you have is appropriate for the application you are running. Please make sure you provide your evrilicense.lic file.