This article is aimed at IT departments and systems administrators that would like to use a deployment solution to easily provide all staff devices with Little Green Button.
Simplifying Setup & Deployment to Multiple Workstations
Deploying Little Green Button to the computers in your organisation need not necessarily require a physical visit to each workstation.
Systems administrators use technologies such as Microsoft System Center Configuration Manager (SCCM), Group Policy Objects (GPO), Windows Sysinternals or an equivalent to remotely distribute software to large groups of computers around their business enterprise.
If you plan to remotely distribute Little Green Button using such a technology then you may find the following tips useful.
Prerequisites
The setup and deployment media for Little Green Button is available from the downloads page as a .msi file. When run manually, the .installer checks that two dependencies are installed, namely
- Microsoft .NET Desktop v8 (x86) (found on the right hand side of the .NET downloads page
- Windows Installer (v3.1+)
If either of these dependencies are missing the user is prompted to download and install them before proceeding.
For remote deployment please ensure that these dependencies are already installed on the target workstations by some means. Once this has been accomplished, deploy Little Green Button using the .msi file.
Windows Installer Command Line Parameters
In common with all Windows Installer files, installation of Little Green Button on a target computer using the .msi file can be controlled by command line parameters.
Full guidance on how to use MsiExec and its command-line options can be found over at the Microsoft Docs pages.
A basic command to have an unattended installation without a UI showing could look like this:
msiexec.exe /i c:\path\to\lgbsetup-3.x.xxx.msi ACTIVATIONCODE="abcdef123adbdef=x=" /qn
As part of the installation procedures, Little Green Button attempts to create exceptions in the Windows Firewall. Skip this routine by adding SKIPFIREWALLRULES=1 to the installation command if a third party firewall is used.
Installing Licence
The first time that Little Green Button is run on the target workstation it will prompt the user for a licence activation key. However, this can be avoided by allowing Little Green Button to automatically activate during installation.
This can be done using one of two methods
- Run the installer with the ACTIVATIONCODE parameter as described further on in this article
- Provide the installer with a licence file to be used in parallel with the software installation. To do this place a licence.dat file in the same folder as the installation media, as shown here:
When the Windows Installer file is executed, it will detect licence.dat and copy it to the correct folder on the target workstation.
Little Green Button Installer Parameters
There are a few install parameters you can set during the installation phase. This could come in handy if you'd like to pre-configure a location without using the Groups Configuration on the MyLGB website.
These parameters allow the script to set the default location name for the host, the location's telephone number, the location's geocoded location and whether the user should be prompted to review/change the location.
The parameters are as follows:
ACTIVATIONCODE
Supply an activation code to be used during installation to automatically activate the software on this licence.
LOCATION
Set a location for this installation of Little Green Button (Required if any of the other LOCATION*-parameters are to be used)
LOCATIONTELNUM
Set a telephone number for this location (Optional)
LOCATIONLAT
Latitudinal geolocation coordinate, -90 thru 90 (Optional)
LOCATIONLONG
Longitudinal geolocation coordinate, -180 thru 180 (Optional)
LOCATIONPROMPT
Show the location selection, TRUE or FALSE (Optional)
SKIPFIREWALLRULES=1
Skip the routine that attempts to implement necessary rules in Windows Firewall, 1 (Optional)
Example use for parameters - at the command-line use:
msiexec /i lgbsetup-3.9.xxx.msi LOCATION="Room 17" LOCATIONTELNUM="ext 117" LOCATIONLAT="51.503399" LOCATIONLONG="-0.12787393" LOCATIONPROMPT="FALSE" /qn /l*V "c:\path\to\install.log"
In this example, the Little Green Button will be installed silently, with no interface, with the location "Room 17", phone number "ext 117", the designated latitude/longitude gps coordinates, will not prompt the user for a location, and write out an install.log with the output. If a licence.dat file is present alongside the .msi file, it will also automatically activate.
Example using Windows Sysinternals
PsExec is a free utility that allows an administrator to execute processes on other systems, without having to install client software on the remote computer.
- Download LGB installation media from the downloads page (make sure you download the .msi file).
- Save the .msi file to a location on your network that is accessible to all computers.
- Obtain PsExec by downloading Windows Sysinternals Process Utilities.
- Unpack the PSTools.zip file to a folder on your computer.
- At a cmd prompt customise this command to your needs:
c:\PSTools\psexec \\REMOTENAME -u "DOMAIN\Username" -p "PASSWORD" cmd /c "msiexec.exe /i "\\SERVERNAME\lgbsetup-3.9.xxx.msi" /quiet /forcerestart"
Take care to include all the apostrophes and modify- c:\PSTools\psexec to the drive and folder where you unpacked PSTools.zip,
- \\REMOTENAME to the name of the target computer where LGB is to be installed,
- DOMAIN\Username to the domain name and username of an account on the target computer (must be an administrator account),
- PASSWORD to the selected account’s password,
- \\SERVERNAME\lgbsetup-3.9.xxx.msi to the location on the network where the installation media can be found.
- When you run the customised command you will get a short output from PsExec and display any error codes.
Note: the “error” code 1641 is expected. Code 1641 indicates that installation was successful and a reboot is now required.
- On the remote computer it will appear that not much is happening. However, in the background, Windows Installer will be preparing Little Green Button for use. Be patient, this may take a few minutes, depending on the speed of the remote computer. The final phase of installation requires the remote computer to be restarted. This happens automatically.
- After the remote computer has been restarted Little Green Button is ready for use.
Tip: The instructions above demonstrate how to install on a single remote computer. However, PsExec accepts a @file parameter which directs it to run the specified process on each computer name listed in a text file. Use this feature to install Little Green Button on multiple workstations.
Unfortunately, troubleshooting PsExec and customising your commands fully is beyond the scope of this article but there is plenty of documentation to be found over in the Microsoft Docs section.
Troubleshooting Installation Problems
Windows Installer can generate a log file which can assist when diagnosing problems with the installation. By default, no log is created. To instruct Windows Installer to log the installation, include the /l*V [logfilename] parameters on the command line, e.g.
msiexec /i lgbsetup-3.0.xxx.msi /l*V “c:\install.log”
Additionally, during installation, Little Green Button logs the progress of custom actions to a text file named lgb3CustomActions.txt in the user’s temp folder.