HLServer: OS X Server Setup
From Headus Docs
Revision as of 04:07, 15 January 2014 (edit) Headus (Talk | contribs) ← Previous diff |
Current revision (08:59, 12 September 2017) (edit) (undo) Headus (Talk | contribs) |
||
(17 intermediate revisions not shown.) | |||
Line 1: | Line 1: | ||
- | {{:HLServer: Menu}} Select or create a new user that will be used to run the hlserver daemon. Login as that user, open up a shell window, extract the TGZ file into a temporary directory, change to that directory and run the setup script ... | + | {{:HLServer: Menu}} Download the TGZ file and double click it to extract the contents into the '''hlserver''' folder. |
- | tar xvfoz hlserver-osx-111202.tgz --directory=/tmp | + | The following files make up the OS X license server installation: |
- | cd /tmp/hlserver | + | |
- | ./setup | + | |
- | First you'll be asked to edit the config file. If you are familiar with '''vi''', then run 'vi hlserver.conf' from the shell window. If you prefer to use Finder, double click '''hlserver.conf'''; if prompted for an editing application, select '''TextEdit'''. You should at least change the IP range for "GROUP lan" to reflect your local setup. | + | <ul> |
- | Re-run the setup script and the keys file is checked. If you have your license keys already, cut'n'paste them into the '''sample-keys''' file, otherwise email the 5 code strings to your vendor for some license keys. As with the config file above, you can either use '''vi''' from the shell window, or '''TextEdit''' from Finder, to edit the sample keys file. Once the keys are in the sample keys file, use the shell window to rename it to '.keys' ... | + | ; hlserver : This is the server application. |
- | mv sample-keys .keys | + | ; hlmanager : This is the manager application. See [[HLServer: The Manager|The Manager]] chapter for details. |
- | Re-run the setup script and you'll be asked for an installation location. By default the script will want to put the binaries and config files into '''/usr/local/hlserver''', but you can type in a different path at the prompt if you wish. | + | ; hlserver.conf : The contents of this file, explained in detail in the [[HLServer: Server Config|Server Config]] chapter, controls the behavior of the server. |
+ | |||
+ | ; hlserver.log : This is a series of date stamped log messages from the server showing, amongst other things, who is grabbing which licenses. | ||
+ | |||
+ | ; setup : Installation script. | ||
+ | |||
+ | ; uninstall : Remove service daemon and all files. | ||
+ | |||
+ | ; unload : Unload service daemon, but leave all the files intact. | ||
+ | |||
+ | ; reload : Restart the service daemon. | ||
+ | |||
+ | ; keys.txt : This file holds the floating license keys. Was called '''.keys''' in earlier versions. | ||
+ | |||
+ | </ul> | ||
+ | |||
+ | == Setup v2 == | ||
+ | |||
+ | Double click the '''setup''' script to start the installation. | ||
+ | |||
+ | First you will be asked where you want to install the hlserver | ||
+ | files, so just tap the Enter key here to accept the default ... | ||
+ | |||
+ | <pre> | ||
+ | If prompted, type in your password for sudo access. | ||
+ | |||
+ | Installation location (/usr/local/hlserver) ? | ||
+ | </pre> | ||
+ | |||
+ | Next you will most likely be asked for your password for sudo access; | ||
+ | this is so the install folder can be created and the service daemon | ||
+ | started ... | ||
+ | |||
+ | <pre> | ||
+ | sudo mkdir -p /usr/local/hlserver | ||
+ | Password: | ||
+ | sudo chown architec /usr/local/hlserver | ||
+ | sudo cp com.headus.hlserver.plist /Library/LaunchDaemons | ||
+ | sudo chown root /Library/LaunchDaemons/com.headus.hlserver.plist | ||
+ | sudo chmod 644 /Library/LaunchDaemons/com.headus.hlserver.plist | ||
+ | cp -f hlmanager hlserver hlserver.conf .keys /usr/local/hlserver | ||
+ | sudo launchctl unload /Library/LaunchDaemons/com.headus.hlserver.plist | ||
+ | sudo rm -f /tmp/hlserver.pid | ||
+ | sudo launchctl load /Library/LaunchDaemons/com.headus.hlserver.plist | ||
+ | </pre> | ||
+ | |||
+ | After that, the setup script will wait for the service to start up, and | ||
+ | then runs the hlmanager command ... | ||
+ | |||
+ | <pre> | ||
+ | Waiting for HLServer to start ... 10 9 8 | ||
+ | Trying HLManager ... | ||
+ | Trying architec@localhost ... Connected ... Fetching ... | ||
+ | </pre> | ||
+ | |||
+ | Once hlmanager is connected, you will see something like this ... | ||
+ | |||
+ | <pre> | ||
+ | Server v2.00 localhost up 00:00 | ||
+ | |||
+ | Your login has been added automatically to | ||
+ | the hlserver.conf file for Manager access. | ||
+ | If you want to add Manager access for other | ||
+ | users, you will need to edit that file on | ||
+ | the server. | ||
+ | |||
+ | ---------------------------------------------- | ||
+ | |||
+ | No valid floating licenses found. Please | ||
+ | email the following code to your vendor so | ||
+ | new license keys can be generated. | ||
+ | |||
+ | RF55 RDH4 WGA4 9P2D XECG F530 2MHX 9ZST | ||
+ | |||
+ | Copy of above code: '/tmp/hlmanager-code.txt' | ||
+ | |||
+ | If you've already received your license keys, | ||
+ | now use the "add" command to append one at | ||
+ | a time to the keys file on the server. | ||
+ | </pre> | ||
+ | |||
+ | So email that code to your vendor to get your license keys. | ||
+ | |||
+ | Once you have some keys, re-run '''hlmanager''' and use the 'add' command to append them to the keys file on the server. You should see something like this once the keys have been added. | ||
+ | |||
+ | <pre> | ||
+ | > add | ||
+ | Enter key string below ... | ||
+ | FMWM 6N8S 0BPS 4FXP K4GL W7H7 6JFY R8B4 8NDB JP3A | ||
+ | Sending key to server ... | ||
+ | Updating status ... | ||
+ | Server v2.00 localhost up 00:05 | ||
+ | <--------- Licenses ----------> | ||
+ | Name Status Free Used | ||
+ | uvlayoutv2 29 days 4 0 | ||
+ | </pre> | ||
+ | |||
+ | Users should now be able to access the license server from others systems on the local network. | ||
+ | |||
+ | hlserver will be automatically restarted whenever the system is rebooted, and you can stop and start it via the '''launchctl''' command. | ||
+ | |||
+ | We recommend you keep a copy of the '''hlmanager''' command, but the rest of the contents of that extracted hlserver folder can now be deleted. | ||
+ | |||
+ | == Setup v1 == | ||
+ | |||
+ | Double click the '''setup''' script to start the installation. | ||
+ | |||
+ | # First you'll be asked to check the config file. The "GROUP lan" IP range will have been set already to match your local network, but this may need to be adjusted if you have a more complicated setup (e.g. multiple sub-nets in a larger campus network). Save the file, kill the window, then re-run the '''setup''' script to continue.<br><br> | ||
+ | # Initially you wont have license keys, so at the "Do you have the keys" question type '''n''' followed by Enter to generate the code strings. Email the 5 code strings to your vendor to get your license keys.<br><br> | ||
+ | # When you get your license keys, re-run the '''setup''' script and answer '''y''' to the "Do you have the keys" question, then type Enter to continue and the keys file will open up in the text editor. Cut'n'paste your license keys in, save the file, kill the window, then re-run the '''setup''' script to continue.<br><br> | ||
+ | # At the "Do you have updated license keys" question, answer '''n''' and then you'll be asked for an installation location. By default the script will want to put the binaries and config files into '''/usr/local/hlserver''', but you can type in a different path at the prompt if you wish. | ||
If the setup script runs smoothly, hlserver will be started and hlmanager is run as a final check. You should see something like the following as output ... | If the setup script runs smoothly, hlserver will be started and hlmanager is run as a final check. You should see something like the following as output ... | ||
Line 25: | Line 133: | ||
hlserver will be automatically restarted whenever the system is rebooted, and you can stop and start it via the '''launchctl''' command. | hlserver will be automatically restarted whenever the system is rebooted, and you can stop and start it via the '''launchctl''' command. | ||
- | The following files make up the OS X license server installation: | + | We recommend that you keep the '''hlserver''' folder in case you need to re-run the '''setup''' script. It can be moved if you dont want to leave it on your Desktop or in the Downloads folder. |
- | <ul> | + | == Update == |
- | ; hlserver : This is the server application. | + | If you need to update your keys file (e.g. replacing temp keys with permanent ones) then re-run the '''setup''' script and answer '''y''' to the "Do you have updated keys" question. Type Enter to edit the keys file, cut'n'paste in the new keys, then save the file, kill the window, and re-run the '''setup''' script to restart HLServer and check the results with HLManager. |
- | + | ||
- | ; hlserver.conf : The contents of this file, explained in detail below, controls the behavior of the server. | + | |
- | + | ||
- | ; hlserver.log : This is a series of date stamped log messages from the server showing, amongst other things, who is grabbing which licenses. | + | |
- | + | ||
- | ; hlmanager : This is the manager application. See "The Manager" chapter for details. | + | |
- | + | ||
- | ; .keys : This file holds the floating license keys. | + | |
- | + | ||
- | </ul> | + |
Current revision
|
Download the TGZ file and double click it to extract the contents into the hlserver folder.
The following files make up the OS X license server installation:
[edit] Setup v2Double click the setup script to start the installation. First you will be asked where you want to install the hlserver files, so just tap the Enter key here to accept the default ... If prompted, type in your password for sudo access. Installation location (/usr/local/hlserver) ? Next you will most likely be asked for your password for sudo access; this is so the install folder can be created and the service daemon started ... sudo mkdir -p /usr/local/hlserver Password: sudo chown architec /usr/local/hlserver sudo cp com.headus.hlserver.plist /Library/LaunchDaemons sudo chown root /Library/LaunchDaemons/com.headus.hlserver.plist sudo chmod 644 /Library/LaunchDaemons/com.headus.hlserver.plist cp -f hlmanager hlserver hlserver.conf .keys /usr/local/hlserver sudo launchctl unload /Library/LaunchDaemons/com.headus.hlserver.plist sudo rm -f /tmp/hlserver.pid sudo launchctl load /Library/LaunchDaemons/com.headus.hlserver.plist After that, the setup script will wait for the service to start up, and then runs the hlmanager command ... Waiting for HLServer to start ... 10 9 8 Trying HLManager ... Trying architec@localhost ... Connected ... Fetching ... Once hlmanager is connected, you will see something like this ... Server v2.00 localhost up 00:00 Your login has been added automatically to the hlserver.conf file for Manager access. If you want to add Manager access for other users, you will need to edit that file on the server. ---------------------------------------------- No valid floating licenses found. Please email the following code to your vendor so new license keys can be generated. RF55 RDH4 WGA4 9P2D XECG F530 2MHX 9ZST Copy of above code: '/tmp/hlmanager-code.txt' If you've already received your license keys, now use the "add" command to append one at a time to the keys file on the server. So email that code to your vendor to get your license keys. Once you have some keys, re-run hlmanager and use the 'add' command to append them to the keys file on the server. You should see something like this once the keys have been added. > add Enter key string below ... FMWM 6N8S 0BPS 4FXP K4GL W7H7 6JFY R8B4 8NDB JP3A Sending key to server ... Updating status ... Server v2.00 localhost up 00:05 <--------- Licenses ----------> Name Status Free Used uvlayoutv2 29 days 4 0 Users should now be able to access the license server from others systems on the local network. hlserver will be automatically restarted whenever the system is rebooted, and you can stop and start it via the launchctl command. We recommend you keep a copy of the hlmanager command, but the rest of the contents of that extracted hlserver folder can now be deleted. [edit] Setup v1Double click the setup script to start the installation.
If the setup script runs smoothly, hlserver will be started and hlmanager is run as a final check. You should see something like the following as output ... Waiting for HLServer to start ... 10 9 8 Trying HLManager ... Trying architec@localhost ... Server localhost up 4 seconds <--------- Licenses ----------> <------------------------- Users -------------------------> Name Status Free Used Id Hostname User App Age Idle uvlayoutv2 29 days 4 0 hlserver will be automatically restarted whenever the system is rebooted, and you can stop and start it via the launchctl command. We recommend that you keep the hlserver folder in case you need to re-run the setup script. It can be moved if you dont want to leave it on your Desktop or in the Downloads folder. [edit] UpdateIf you need to update your keys file (e.g. replacing temp keys with permanent ones) then re-run the setup script and answer y to the "Do you have updated keys" question. Type Enter to edit the keys file, cut'n'paste in the new keys, then save the file, kill the window, and re-run the setup script to restart HLServer and check the results with HLManager. |