PLEASE NOTE! If you are upgrading from a version prior to 2018.1.*, e.g. 2.5.*, please use the 2018.1 upgrade guide instead of this installation guide.
To get an overview of the components of the LEAPWORK Automation Platform, please visit the Architecture Overview.
To start the installation, do the following:
Double-click the .msi-file to start the installation.
The first screen will display the version number and ensure that the downloaded version fits your computer. Click 'Next' to begin the installation.
Choose which of the three components to install on the computer. Do this by clicking the drop arrows and choosing the appropriate option for each component. For trial purposes, keep the default selection (all three components).
The Configuration screen contains properties used for one or more of the components. All the settings can be changed afterwards in the config files for the individual components: ‘studio\studio.config’, ‘controller\controller.config’ and ‘agent\agent.config’. The files are in the installation directory – typically ‘c:\program files\LEAPWORK\’.
Note: Save the database encryption key, which is used to protect the database files created during the upgrade. This key is used to allow the Controller to gain access to the database files, so in case the Controller needs to be moved to a new machine or in case of a restore of the LEAPWORK system, this key is needed.Save the key in a protected and safe place.
Path to assets. This is the path to the file system folder which contains the encrypted SQLite database files holding all LEAPWORK assets, including automation flows, schedules, and run results.
Controller port. Studio and the Controller always communicate using internal API calls, and this requires the use of a TCP port. The default is port 9000, which you can change to any other port number that is not in use by other software on your computer. NOTE: Unless it is necessary for any particular reason, we do not recommend changing either the Controller, Controller API or Agent port numbers.
Controller API port. For any integration effort, access LEAPWORK’s open REST API using the port number set here. The default is port 9001, which you can change to any other port number that is not in use by other software on your computer. NOTE: Unless it is necessary for any particular reason, we do not recommend changing either the Controller, Controller API, or Agent port numbers.
Add exceptions for the Controller in Windows Firewall. A check in this box will direct the installation process to add a rule to the Windows Firewall to permit all incoming connections to the Controller. NOTE: Because the LEAPWORK Automation Platform is also often used in corporate and already secure test networks, the password is optional.
Click “Next” on the configuration screen.
Specify a password for the default user (“Admin”). The “admin” user is used for the first login in Studio after the installation. Note, that the password you enter for the admin user is securely located in your local installation only. LEAPWORK cannot assist in retrieving this password should you forget it.
Click “Next” on the configuration screen.
The configuration screen contains several settings that you can modify before completing the installation. By default, the Agent talks to the Controller over port 6777, user can change it if needed. LEAPWORK Agents now include a strong security feature to automate logging in and out of Windows. A user is no longer required to be logged into their machine in order to run a flow. Instead, LEAPWORK can be set up to login on the user’s behalf. Users can also start testing single-sign on between Windows and any other application that reuse the same login credentials, User has to choose Windows login to be able to use windows credential to configure the Agent OR user can choose the old way of setting a password. The password is left blank by default.
Agent port. Automation flows run in the Agent, which communicates with Studio and the Controller through a closed remote-control protocol on a specific TCP port. The default port is 6777, which you can change to any other port number not in use by other software on the computer. NOTE: Unless it is necessary for any particular reason, we do not recommend changing either the Controller, Controller API, or Agent port numbers.
Agent password. Because the Agent uses a remote-control protocol, we advise you to set a password to prevent unauthorized parties from connecting to it.
The settings explained
Please note: LEAPWORK Agent passwords will begin deprecation and is expected to be removed from the product before the end of the year.
Add exceptions for the Agent in Windows Firewall. A check in this box will direct the installation process to add a rule to the Windows Firewall to permit all incoming connections to the Agent.
When you are happy with the configuration, click “Next” to continue and then “Install” on the next screen:
After the installation is complete, click 'Continue'.
After the installation is complete, click on ‘Ok’ and 'Finish' to exit the installer.
If you have an existing distributed setup of LEAPWORK, repeat the installation guide for each LEAPWORK component and machine in your environment.
After installing all LEAPWORK components, start LEAPWORK Studio. The Controller will broadcast its location (IP address), so in most cases, Studio already knows the location of the Controller at the first start. Once logged in as admin, Studio will prompt you to enter the license key.
The license key is stored on the Controller, and only need to be added once.
To obtain the license key, click the link in the dialogue, which will open a browser and take you to account.leapwork.com. On account.leapwork.com you will have to log in using your e-mail and the password provided when signing up on leapwork.com:
In case of problems with the login, please contact LEAPWORK Customer Success.
After successful login on leapwork.com, the license management page opens. This page contains a few different sections:
Get license key:
Copy the license key by clicking 'Copy license key'
Whenever you generate a license key, it is added to this list, so it's possible to download the license key and gain an overview of the active licenses.
It is fully acceptable to deactivate a license and generate a new license with another number of Agents. Read more about License Management.
In Studio, paste the copied license key into the field and click OK.
LEAPWORK is now ready for use.