Fuzor - Network License Server Manage FUZOR NETWORK LICENSE SERVER MANAGER. Copyright 2014 Kalloc Studios, Inc. All rights reserved.

Transcription

1 FUZOR NETWORK LICENSE SERVER MANAGER Copyright 2014 Kalloc Studios, Inc. All rights reserved. 1

2 Table of Contents Introduction...4 Overview...4 Quick Install...4 Network License Server Controller GUI Quick Reference...5 Connecting...5 Product Key...6 Active Users...6 Live Log...6 Installing the Network License Server Manager...7 Install...7 Setting up the Network License Server Manager...9 Opening the settings.ini file...9 Setting the License Port TCP...11 Setting the Control Port TCP...11 Allowing/Denying IP's...11 Allow Permissions...12 Deny Permissions...12 Difference Between License Port and Control Port...12 Setting up the Idle Detection Feature...12 Using a Proxy Server...13 Example settings.ini File...13 Creating Reports...15 Reporting Options...15 Setting Up a Report...16 Understanding Your Report...17 Using the log.txt File...18 Opening the log.txt file...18 Log File Syntax...18 Adding Keys to the Network License Manager...19 Open the License Server Controller...19 Adding A Key...19 Removing A Key

3 Revoking A Key...21 Installing Fuzor with a Network License...22 Network License Server Controller with Active User...24 Troubleshooting...25 Errors While Connecting to the Server with the Controller...25 Errors While Connecting to the Server from Installation of Fuzor our While Launching Fuzor...26 Error Connecting to the Server While Running Fuzor...27 Error While Trying to Add A Key to the Server...28 FAQ's...29 How can I connect to the network server?...29 How do I find my IP address?...29 How do I find my host name?...29 Can I choose what key I get from the server?...30 How can I get the Host address for the Network License Server?...30 What does the / at the end of the IP address mean?...30 What is the difference between the License Port and the Control Port?...30 I changed the ports in the settings.ini, but the changes did not take effect. What did I do wrong?...31 What is a network license?...31 I opened the Network License Server Controller, but I am not able to connect to the license server. What is wrong?...31 How do I find my proxy server settings?

4 Introduction Overview This is the user manual for Fuzor Network License Server Manager. This document will cover the installation, setup, and managing of the license server. If you run into issues that are not covered in this manual, please contact us at and we will assist you in correcting the problem. A network license is designed to allow multiple users access to Fuzor using the same product key on different machines. There can only be one user to the Product Key at one time. The product keys are managed on a Network Server that will handle distribution, authentication, and removal. If there are no keys available users will not be allowed to launch Fuzor. New users will be able to install Fuzor using the network license server even if there are no available keys. The Network License Server Controller is a GUI for the license server, it will allow a user to monitor/add/remove the active product keys. Along with the ability to remove product keys, the controller will allow users to be removed from the server to free up keys. Quick Install 1. Download the Network License Server Zip File. 2. Unzip the file in the location you would like to use as the install directory 3. Right click the install.bat file and choose Run as administrator NOTE: You will know when the install is complete when you see Press any key to continue... in the console. 4. Run NetworkLicenseServerController.exe 5. Press the Connect button. NOTE: This quick install guide is assuming you are using the NetworkLicenseServerController.exe on the same machine the server is installed. If this is not the case, please refer to the full install guide of this manual. 6. Enter a Product Key in the Product Key Text Box 7. Press the Add button NOTE: You should now have a key in the Products Keys section of the UI, 8. Now follow the Install Fuzor with a network license guide to install Fuzor. 4

5 Network License Server Controller GUI Quick Reference 1. Server Connection section 2. Product key section 3. Active users section 4. Network Server Controller Live Log section Connecting 1. License Server Address Address the controller will try and connect to the server on. 2. Connect Button Starts the connect to the license server. 3. Generate Report Button Opens the Generate Report Options box allowing the creation of network license usage reports 5

6 Product Key 1. Product Key Product keys that are on the server. 2. Product Type The type of product the key belongs to. 3. Machines Used The number of PC's the key can be on, and the number of machines the key is currently on. 4. Expire Time When the product is due to expire. 5. Product Key Text Box Text box used to enter new product keys. 6. Add Button Starts the addition process of a new product key. 7. Remove Selected Key Removes the selected key from the Product Key section. Active Users 1. Username The Windows username of the active user. 2. Users Address The IP address of this active user. 3. User Time The length of time the users has been using the key. 4. Product Key The product key that the user is using. 5. Product The product that the key belongs to. 6. Revoke Selected User Will revoke the license from the current user. Live Log 1. Active Log Current log events will print here. 6

7 Installing the Network License Server Manager NOTE: All batch files will need to be run as administrators. Install 1. Download the Network License Server Zip file. 2. Unzip the file in the location you would like to use as your install directory. 3. Run the install.bat file(right click and chose Run as administrator ). This will install DotNet 4.0 redistributable, vs1020 redistributable, and the Fuzor Network License Server. 7

8 NOTE: You will know when the install is complete when you see Press any key to continue... in the console. Once the installation is complete the server will be running and ready to use. If changes need to be made to the TCP ports, they can be made in the settings.ini. This file was created when the installation was completed, and was created from the default settings in windows ( Internet Protocol Version 4 (TCP/IPv4) Properties ). NOTE: Always right click and choose Run as administrator for all *.bat (batch) files. 8

9 Setting up the Network License Server Manager NOTE: After changes are made to the settings.ini the Network License Manager will need to be restarted. To do this use the start.bat or stop.bat batch files. These batch files were extracted from the original downloaded ZIP file. Right click and choose Run as administrator for batch files. Opening the settings.ini file 1. Navigate to the installed directory for the Network License Server Manager (this should be were you ran the install.bat file). 2. Right click on stop.bat and choose Run as administrator to stop the server. NOTE: Changes will only take effect once the server is stopped and started. 9

10 3. Open settings.ini in a text editor. 4. After changing settings inside the settings.ini right click on start.bat batch file and choose Run as administrator to start the Network License Server. 10

11 Setting the License Port TCP The License Port section handles the settings for the license request connections from the Fuzor installer and from Fuzor. Default port: Changing the License Port: 1. Right click the stop.bat batch file and choose Run as administrator. 2. Open the settings.ini file. 3. Under the section [LicensePort] change the line port=45180 to your desired port. 4. Save and close settings.ini 5. Right click the start.bat batch file and choose Run as administrator. Setting the Control Port TCP The Control Port section handles the setting for the Fuzor License Manager connections. Default port: Changing the Control Port: 1. Right click the stop.bat batch file and choose Run as administrator. 2. Open settings.ini file 3. Under the section [ControlPort] change the line port=45181 to you desired port. 4. Save and close the settings.ini 5. Right click the start.bat batch file and choose Run as administrator. Allowing/Denying IP's Under the [LicensePort] line, after the TCP port line, users will be able to allow or deny access to specific IP's. This list is checked in a top down order, and IPs are denied by default. If an IP address is given an allow permission at the top, then a deny permission at the bottom, the IP will get the topmost permission, in this case allow. Example: [LicensePort] port=41580 allow= /32 deny= /32 NOTE: This will allow access to IP /32 because the allow appears first in the list. 11

12 Allow Permissions Use the following format to add the allow permissions to various IP addresses. allow=ip Address/Subnet allow= /32 Examples: allow= /24 Gives all IP's starting with allow permissions. allow= /16 Gives all IP's starting with allow permissions. allow= /0 Gives all IP's allow permissions. Deny Permissions Use the following format to add deny permissions to various IP addresses. deny=ip Address/Subnet deny= /32 Examples: deny = /32 Denies access to this IP deny = /24 Denies access to all IP addresses starting with deny = /16 Denies access to all IP adresses starting with deny = /0 Denies access to all IP addresses NOTE: deny= /0 is the default for all IP's and does not need to be added. NOTE: You must use the short hand version for subnet rather than a full subnet mask. For example: with a subnet mask of should be written as /24 Difference Between License Port and Control Port IP addresses under the License Port section are the computers that are able to connect to the license server to use and install Fuzor. IP addresses under the Control Port section are able to connect to the Network License Server and make modifications using the Controller. Setting up the Idle Detection Feature The idle detection feature tracks current users that have checked out a license from the license server. When a license is requested but none are available, the server checks if any idle users have been idle longer than the set idle time. If so the user with the longest idle time is kicked and the key is granted to the new requester. The idle settings are set in the settings.ini. 12

13 Example: [IdleSettings] IdleCheckEnabled = 1 IdleThresholdMinutes = 60 To enable the idle detection set the IdleCheckEnabled equal to 1. Setting the IdleThresholdMinutes changes the minimum amount of time before a user is considered idle. NOTE: These changes only take effect once the server is started. If changes are made to these setting after the server is running, the server will have to be restarted. Using a Proxy Server To use a proxy server with the network license server, users will have to configure the Proxy settings in the settings.ini. In the Proxy section of the settings.ini, enable the proxy settings by setting Enable to 1: Enable = 1. Now set the proxy address and port information. Once the settings.ini changes have been made, start the network license server. If the server was already running before the changes were made, follow the server restart instructions to all the changes to take effect. The Fuzor License portal also can use proxies with name and password security. If you do not have a username or password, both can be left blank. NOTE: Proxy server option is disabled by default. Example: [Proxy] Enabled = 1 Address = yourproxy.address.com Port = 8080 Username = MyUsername Password = MyPassword Example settings.ini File [LicensePort] port=45180 deny= /32 allow= /24 allow= /24 13

14 allow= /32 [ControlPort] port=45181 allow= /32 allow= /32 [IdleSettings] IdleCheckEnabled = 0 IdleThresholdMinutes = 120 [Proxy] Enabled = 0 Address = yourproxy.address.com Port =

15 Creating Reports Users are able to use the Network License Controller to create usage reports. These reports will show how often product keys are being requested, how long the keys are being used, and how many users are being denied a key because of a lack of product keys. These reports are then exported in either a text file, HTML file, or a CSV spreadsheet. Reporting Options Start Date The date you would like the report to start with. End Date The date you would like the report to end on. Interval The time interval the report will be broken up into. Only Used Days Only days that Fuzor was used will be counted for the report Work Hours Set the hours that the report will consider Include Users Show user IPs in report Format The format the report will be generated in. Hourly Report broken up into hourly sections. Each hour gives information about the usage of the product keys on the server for that hour. Daily Report broken up into a daily summary of usage for the product keys between start and end dates. Weekly Report broken up into a weekly summary of usage for the product keys between start and end dates. Monthly Report broken up into a monthly summary of the usage for the product keys between start and end dates. Full Summary of the usage for the product keys between the start and end dates. This report will not be broken up into intervals. 15

16 NOTE: Changing the Interval will provide more information in the date section to represent the interval fields that are being used. Setting Up a Report 1. Click the Generate Report button in the server connection area. 2. Set the start date to the date you would like the report to start with. 3. Set the end date to the end date you would like the report to end with. 4. Select an interval for the report. The example image will reflect a one hour interval. 5. Select a format to generate the report in. 6. Click the Generate button. 7. Navigate to the location you would like the report saved. 8. Click the Save button. 16

17 Example: The above image shows a section from an HTML report that had the interval set to hours. Understanding Your Report You can use the image from the end of the Setting Up a Report section to see the positioning and layout of these sections. Product The product for this row. Available: Max Shows the number of product keys on the server for that interval time. Available: Hours The total number of usable hours available during that interval time. License Requests: Total The total number of requests for a product key during that interval time. License Requests: Used The total number of times a product key was given. License Requests: Denied The total number of times a product key was denied due to lack of keys. License Requests: % Denied Shows the percentage of requests which were denied. Used: Max The highest number of product keys actively being used at the same time. Used: Hours The total number of hours all key's were being used. Used: % Hours The percentage of time all key's were being used. Dates Used When report figures span multiple days, this calander will show exactly which days Note: All numbers that are not percentages are rounded to the closest integer. Percentage values are created from the actual numbers, not the rounded numbers. Example: The image above shows the time stamp for an interval report. The Format is YEAR- MONTH-DAY TIME through YEAR-MONTH-DAY TIME Timezone. This time stamp was taken from a one hour interval. 17

18 Using the log.txt File In the same directory as the settings.ini there is also a log.txt file. This file will hold all of your Network License Server information. The text that is seen printing to the bottom of the Network License Server Controller is saved to the log.txt. If issues are seen with keys not showing up, users are able to check the log for information on why they are not included in the active keys. Opening the log.txt file 1. Navigate to the Network License Server directory. 2. Open the log.txt file in a text editor. Log File Syntax Each line will start in the log file with a set of [ ]. Inside these brackets will be the [YEAR- MONTH-DAY TIME] of the message. Following the first set of [ ] there will be a second set. The second set will list the message type [INFO] or [ERROR]. After the message type the content of the message will be given. Example Failed Key Server Authorization: [ :05:53][INFO] ADD request for AAAA-AAAA-AAAA-AAAA-AAAA-AAAA- AAAA-AAAA received. [ :06:08][ERROR] Authorization for product key AAAA-AAAA-AAAA-AAAA- AAAA-AAAA-AAAA-AAAA failed. Error: KEY NOT FOUND. Example Successful Key Server Authorization: [ :30:17][INFO] ADD request succeeded for 1FG2-QHGW-8XKS-1FD6-AH6U- MD1T-A17R-NMWM: Product key 1FG2-QHGW-8XKS-1FD6-AH6U-MD1T-A17R-NMWM has been authorized. Product: Fuzor Premium. Number of Machines: 2. Expire time: Never. Example Successful Release of Key [ :40:54][INFO] Successfully released key 1FG2-QHGW-8XKS-1FD6-AH6U- MD1T-A17R-NMWM. Example Successful Client Connection: [ :49:12][INFO] [ :50941] Connected. [ :49:12][INFO] [ :50941] License connection allowed through IP filter. NOTE: This is an error message for a wrong key being added to the manager. 18

19 Adding Keys to the Network License Manager Open the License Server Controller Once the license server is setup and running: 1. Click and launch NetworkLicenseServerController.exe (This will open the network manager GUI). 2. Now enter the Server IP address and Control Port into the Server Text Box. 3. Click the Connect button. Example: localhost:45181 NOTE: This example uses local host because I am accessing the server from the server machine. If you are using the controller from a machine that is not hosting the server, make sure the settings.ini has your IP allowing access in the Control Port section. Accessing from another computer other then the hosting computer will use the servers IP instead of localhost. Adding A Key Now connected users will be able to enter Keys into the Product Key Text Box. When the Key has been entered users can click the Add button. This will check the validity of the Key. If the Key is valid then it will be added to the active product key section as well as to the licenses.dat file. 1. Enter the Key into the Product Key Text Box. 2. Press the Add button. 3. If the key is not validated on our server this message will be given. 4. If the key is validated on our server this message will be given. 19

20 5. Click the OK button on the successful message and the Key will now appear in the Product Key section of the controller. NOTE: In the image above you can see the Active Log is showing all of the information from the Adding a Key steps. Removing A Key Users are also able to remove Keys from the Network License Server. To remove a Key: 1. Select the Key in the Product Key section. (The Remove Selected Key should now become an active button). 2. Click the Remove Selected Key button. 3. Click Yes on the pop up and the key will be removed from the Product Key Section. Revoking A Key Users are also able to Revoke a key from an active user. To revoke a key: 1. Highlight the active user that you wish to revoke the key form. Now click the Revoke Selected User. 20

21 2. This will open a pop up window asking if you would like to revoke the user, click Yes. 3. On the users end they will receive an error informing them that they have lost connection to the server. Their session in Fuzor will be shutdown. 21

22 Installing Fuzor with a Network License Once the Network License Server is configured and running users will now be able to install Fuzor using Network Keys. To install Fuzor with a Network Key: 1. Download the latest version of Fuzor. 2. Launch the Fuzor Setup Wizard. 3. Click the Next button on the first setup wizard page. 4. Read and accept the License and Service Agreement then click Next. 22

23 5. On the next page you are given two options. Enter a product key or Use a network license. Select Use a network license. This will open a Network License Server Text Box. Enter in the server IP : License Port. Then click the Next button. NOTE: The server IP is the IP address of the computer the license server is installed on. NOTE: Make sure your port is the same port used in the License Port section from the settings.ini file. If you do not know this or you do not have access to this file contact your IT department for help. The default port is

24 6. Now the install Wizard will install Fuzor onto the machine. Once the install is complete the final install wizard page will open. Click Finish. Network License Server Controller with Active User This image shows the Active User section of the Network License Server Controller when someone is connected. 24

25 Troubleshooting The troubleshooting section will go over common errors seen while using the Network License Server. If you encounter errors that are not covered in this section please contact us at or through our web page at Errors While Connecting to the Server with the Controller If you are having issues connecting to the sever while using the Network License Server Controller please follow these steps to help troubleshoot the issue. Right click the start.bat file and choose Run as administrator in the Network License Server install directory. This will make sure that the server is running and there is something to connect to. If you are still having connection issues check the settings.ini file and make sure that your PC's IP has the allow permissions needed to access the server. Your PC's IP should be listed under the Control Port section. If you are still unable to connect to the server make sure there is no general deny permissions above your PC's IP address in the control port section. Example: deny= /24 allow= /32 -->this is your PC's IP allow= /32 25

26 In the above example the deny is for all IP's that begin with Your IP meets these requirements so when your computer tries to connect it receives a deny permission and is not allowed to connect. Removing the general deny statement to the end, or removing it all together will fix the issue (the default permission for all IP's is deny). For more information on this system please refer to the Allowing/Denying IP's section of this manual NOTE: After you changing settings.ini make sure that the server gets reset so the changes will take affect. Errors While Connecting to the Server from Installation of Fuzor our While Launching Fuzor If you are installing Fuzor and are attempting to use the Use a network license option you will need to make sure that your IP has been granted permissions to access the server. If you do not have control over this option please contact the individual that does (most likely the IT department). If you do have access to the server install directory then check to make sure that the server is running. In the server install directory right click on the start.bat file and choose Run as administrator to start the server. If you are still unable to install Fuzor move onto the next step. Next: Right click on the stop.bat and choose Run as administrator to stop the server. Now open the settings.ini and make sure that your computers IP has allow permissions under the License Port section. If you are not familiar with the rules for this please refer to the Allowing/Denying IP's section of this manual. This will walk you through adding permissions to the server. Once you have added the IP's to the settings.ini right click the start.bat file and choose Run as 26

27 administrator to launch the newly configured server. Error Connecting to the Server While Running Fuzor If you are running Fuzor on a network license and you received this error message: Either the individual running the Network License Server Controller revoked your license, or the server went down. NOTE: If you do not have control over the server please contact your IT department to solve the issue. If you have control over the server go to the server install directory and run the: 1. NetworkLicenseServerController.exe 2. Now connect to the server using the server connect button. 3. If you are unable to connect to the server, then you will need to right click on the start.bat file and choose Run as administrator to start the server. 4. If you are able to connect to the server with the Network License Server Controller then check the log.txt file to see if there are any errors referencing why your session was canceled. 27

28 If you are unable to find an error or you are unable to reconnect to the server through Fuzor please contact Error While Trying to Add A Key to the Server If the Product Key Text Box is inactive (you are not able to type into it) then you are not connected to the server. 1. At the top of the Network License Server Controller click the connect button to reconnect to the server. 2. If this does not work then right click on the start.bat file and choose Run as administrator to restart the server. 3. Once the Network License Server Controller is connected to the server the text box should now be active. If you are receiving this message when adding a product key: Your product key was not found on our server. Recheck to make sure that you entered the product key correctly. If your product key was entered correctly and you are still getting this error please contact info@kalloc.com so that we can verify the validity of your key. 28

29 How can I connect to the network server? FAQ's If you are having issues connecting to the server and you do not have access to the server install directory you will need to contact the individual that monitors this server for help (most likely your IT department). If you do have access to the server install directory navigate to the directory and right click on the start.bat file and choose Run as administrator. This will start the server if it is not already on. If this did not resolve your issue move to the next step. Right click on the stop.bat file and choose Run as administrator to turn the server off. Now open the settings.ini and make sure the problem computers IP has authorization to access the server. If not, add in an allow permissions statement granting the IP address permission. If you need further instructions on this task please refer to the Allowing/Denying IP's section in this document. How do I find my IP address? You will need to use the command prompt to find your IP address. To open your command prompt: NOTE: If you do not have access to the command prompt, contact your IT department to have someone with Administrator rights do it for you. 1. Open the start menu 2. Select the all programs option 3. select the accessories option 4. click on command prompt 5. with the command prompt open type the command: ipconfig 6. hit enter Now locate the line Ipv4 Address among the lines that printed out. This is your IP address. How do I find my host name? You will need to use the command prompt to find your IP address. To open your command prompt: NOTE: If you do not have access to the command prompt, contact your IT department to have someone with Administrator rights do it for you. 1. Open the start menu 2. Select the all programs option 29

30 3. Select the accessories option 4. Click on command prompt 5. With the command prompt open type the command: ipconfig/all 6. Hit enter Now find the line Host Name that printed among the lines. This is your PC's host name. Can I choose what key I get from the server? You can not choose what key you get from the server. You are given an available key for the version you have installed. If you have a pro version installed, then the server will send you an available pro version key. Pro version installs can not use Premium keys, and vise versa. How can I get the Host address for the Network License Server? You will have to contract the person in charge of the server to get this information (most likely your IT department). What does the / at the end of the IP address mean? The / after the IP address separates the IP from the subnet. The Subnet is a single integer value, which is the number of bits in the Subnet Mask. Here is a table of common subnet masks and their integer value representation: Subnet Mask Subnet Value Common Use Example Match all IP addresses / Match IPs with the first number matching Match IPs with the first two numbers matching Match IPs with the first three numbers matching Match only the exact IP given / / / /32 What is the difference between the License Port and the Control Port? The License Port is the TCP port that handles the license communication. All request from Fuzor for installations and license requests are handled through the License Port. The Control Port is the port that allows communication with the server involving addition, removal, 30

31 and maintenance of product keys. This port will most likely be kept to only local access, or given to an IT departments computer. I changed the ports in the settings.ini, but the changes did not take effect. What did I do wrong? You will have to restart the server after making changes to the settings file. To restart the server use the stop.bat and start.bat files. What is a network license? A network license is a license that can be shared between computers and users. This allows large groups, like firms, to purchase a set of licenses that can be shared around the office on all the computers. An office that has four network licenses can have four computers using the product at one time. If a fifth person needs to use Fuzor they will have to wait for one of the four other users to close down their session before the fifth can use Fuzor. Once a licensed network users of Fuzor closes out Fuzor, that key will become available for someone else to use. I opened the Network License Server Controller, but I am not able to connect to the license server. What is wrong? If you do not have access to the license server's install directory you will need to contact your IT department and request access to the server. Make sure that the server is running. If you have access to the install directory use right click on the start.bat batch file and choose Run as administrator to make sure that the server is running. If this did not fix the issue move onto the next step. Make sure that your PC's IP address is among the allowed address under the Control Port section of the settings.ini. If you are unfamiliar with the allow and deny permissions please reference the Allowing/Denying IP's section of this manual. If your IP address was already added to settings.ini and you are still have issues please move onto the next step. If your IP address is among the allowed permissions, make sure there is not a generic permission above your IP address that is denying it access. Please refer to the Allowing/Denying IP's for a more in depth explanation on how this system works. The list is read from top to bottom, so if your IP is being denied because it meets the criteria of a general deny, then it will never make it to the line that gives it the allowing permission(s). How do I find my proxy server settings? To find your proxy server settings: 31

32 1. Open the PC control panel 2. Click on Network and Internet 3. Click on Internet Options 4. Now navigate to the Connections tab 5. Click on Settings in the Dial-up and Virtual Private Network settings 32