Cryptlex Documentation
HomeForumsWeb API ReferenceLogin
Search…
Welcome to Cryptlex!
Getting Started
License Management
User Management
Feature Management
Release Management
Node Locked Licenses
Floating Licenses
Overview
Hosted Floating License Server
On-Premise Floating Licenses
LexFloatServer
Using LexFloatClient
Timed Trials
Licensing Docker Apps
Webhooks
Email Templates
Web Integration
Changelog
Legal
Cryptlex On-Premise
Powered By GitBook
LexFloatServer
LexFloatServer is the server software that leases floating licenses to your app. It is usually installed on some computer (which is referred to as a license server) in your customer's local network. Normally, only one license server is required in your network.
LexFloatServer is designed to be robust, low memory and very fast. Hence, it can even be installed on any old machine connected to the local network.
LexFloatServer has VS2015 runtime dependency on Windows. Make sure dependency is installed before running the server.

Downloading the LexFloatServer

LexFloatServer can be downloaded from the downloads page in the dashboard. Simply login to your Cryptlex account and download LexFloatServer binary for Windows, macOS or Linux:

Configuring the LexFloatServer

LexFloatServer uses a simple YAML based text file as its config file. It expects a config.yml file to be in the same directory as LexFloatServer. If the config file is in some other directory it can be passed using the "-c" option.
The config is loaded at the start of the server. Any changes to the config file will be ignored until the server is restarted.

Starting LexFloatServer in terminal

For testing purpose, you can easily run the LexFloatServer in the terminal (command prompt). To start the server simply pass the "-s" option:
1
lexfloatserver -s
Copied!
You need admin rights to run the LexFloatServer.

Activating the LexFloatServer

LexFloatServer needs to be activated using a license key of type "on-premise-floating" before it can be used. It can be activated using the dashboard, command-line options or Web API.

Using the Dashboard

LexFloatServer provides a web-based local dashboard that can be used to activate the server license.

Online activation

Open the dashboard using http://localhost:8090 URL in your browser. Click the Settings page icon and put in the license key to activate the server

Offline activation

To activate offline click on the "SWITCH TO OFFLINE ACTIVATION" option on the Settings page. Put in the license key to generate the offline activation request file.
After generating the offline response from the Cryptlex admin dashboard for this request, paste the offline response file contents in the input to activate the server:

Using command-line options

Online activation

To activate use "-a" option along with the license key and product file path (if not set in the config.yml file):
1
lexfloatserver -a --license-key LICENSE_KEY
Copied!

Offline activation

To activate offline use "-g" option to generate the offline activation request:
1
lexfloatserver -g --license-key LICENSE_KEY --offline-request FILEPATH
Copied!
After generating the offline response from the admin dashboard, pass it along with "-a" option to activate the server:
1
lexfloatserver -a --license-key=LICENSE_KEY --offline-response=FILEPATH
Copied!

Using Web API

LexFloatServer exposes few API endpoints which can also be used to activate the server.

Online activation

Send a POST request to the /api/server/activate API endpoint with JSON request body containing the license key and optionally the activation metadata.
post
http://localhost:8090
/api/server/activate
Activate server

Offline activation

Send a POST request to the /api/server/offline-activation-request API endpoint with JSON request body containing the license key and optionally the activation metadata.
post
http://localhost:8090
/api/server/offline-activation-request
Generate offline activation request
After generating the offline response from the admin dashboard, send a POST request to the /api/server/offline-activate API endpoint with JSON request body containing the license key and the offline response.
post
http://localhost:8090
/api/server/offline-activate
Activate server offline

Installing LexFloatServer on Windows

LexFloatServer runs as a service on Windows. To install it as a service simply pass the "-i" option along with the service name and optionally a service display name which is displayed in the Windows Services Manager:
1
lexfloatserver -i --service-name myfloatingserver --service-diplay-name MyFloatingServer
Copied!
After installation, it is set to start with the computer and run silently in the background.

Stop/Start LexFloatServer on Windows

To stop or start the server from the command line you need the "service name". If the service name was not passed during installation then it defaults to lexfloatserver-productId (where product id is the id of your product):
1
sc stop myfloatingserver
2
sc start myfloatingserver
Copied!

Uninstalling LexFloatServer on Windows

To uninstall simply pass "-d" option to deactivate the server license and then "-u" option to remove the service:
1
lexfloatserver -d
2
lexfloatserver -u --service-name myfloatingserver
Copied!

Installing LexFloatServer on Linux

LexFloatServer can run as a Systemd, Upstart or SysV service on Linux. To install it as a service simply pass the "-i" option along with the service name:
1
lexfloatserver -i --service-name myfloatingserver
Copied!
After installation, it is set to start with the computer and run silently in the background.

Stop/Start LexFloatServer on Linux

To stop or start the server from the command line, you need the service name. If the service name was not passed during installation then it defaults to lexfloatserver.productId (where product id is the id of your product):
1
sudo service myfloatingserver stop
2
sudo service myfloatingserver start
Copied!

Uninstalling LexFloatServer on Linux

To uninstall simply pass "-d" option to deactivate and then "-u" option to remove the daemon:
1
lexfloatserver -d
2
lexfloatserver -u --service-name myfloatingserver
Copied!

Installing LexFloatServer on macOS

LexFloatServer runs as a launchd daemon on macOS. To install it as a service simply pass the "-i" option along with the service name:
1
lexfloatserver -i --service-name com.mycompany.myfloatingserver
Copied!
After installation, it is set to start with the computer and run silently in the background.

Stop/Start LexFloatServer on macOS

To stop or start the server from the command line, you need the service name. If the service name was not passed during installation then it defaults to com.lexfloatserver.productId (where product id is the id of your product):
1
sudo launchctl stop com.mycompany.myfloatingserver
2
sudo launchctl start com.mycompany.myfloatingserver
Copied!

Uninstalling LexFloatServer on macOS

To uninstall simply pass "-d" option to deactivate and then "-u" option to remove the daemon:
1
lexfloatserver -d
2
lexfloatserver -u --service-name com.mycompany.myfloatingserver
Copied!

Getting server stats

LexFloatServer exposes a stats API endpoint that can be used to get the current stats of the server.
get
http://localhost:8090
/api/server/stats
Server stats

Getting list of floating licenses

LexFloatServer exposes a floating-licenses API endpoint that can be used to get the leased floating licenses.
get
http://localhost:8090
/api/floating-licenses
List of floating licenses

​

Previous
On-Premise Floating Licenses
Next
Using LexFloatClient
Last modified 11mo ago
Copy link
Contents
Downloading the LexFloatServer
Configuring the LexFloatServer
Starting LexFloatServer in terminal
Activating the LexFloatServer
Using the Dashboard
Using command-line options
Using Web API
post
Activate server
post
Generate offline activation request
post
Activate server offline
Installing LexFloatServer on Windows
Stop/Start LexFloatServer on Windows
Uninstalling LexFloatServer on Windows
Installing LexFloatServer on Linux
Stop/Start LexFloatServer on Linux
Uninstalling LexFloatServer on Linux
Installing LexFloatServer on macOS
Stop/Start LexFloatServer on macOS
Uninstalling LexFloatServer on macOS
Getting server stats
get
Server stats
Getting list of floating licenses
get
List of floating licenses