LexFloatServer
Last updated
Last updated
LexFloatServer is the licensing server software that leases floating licenses to your app. It is usually installed on any computer in your customer's local network. In case you have multiple products, each product will require its own instance of LexFloatServer.
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 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:
​​
​​
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.
For testing purposes, you can easily run the LexFloatServer in the terminal (command prompt). To start the server simply pass the "-s" option:
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.
LexFloatServer provides a web-based local dashboard that can be used to activate the server license.
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
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:
To activate use "-a" option along with the license key and product file path (if not set in the config.yml file):
To activate offline use "-g" option to generate the offline activation request:
After generating the offline response from the admin dashboard, pass it along with "-a" option to activate the server:
LexFloatServer exposes a few API endpoints which can also be used to activate the server.
Send a POST request to the /api/server/activate API endpoint with a JSON request body containing the license key and optionally the activation metadata.
POST
http://localhost:8090/api/server/activate
licenseKey
string
License key to activate the server.
metadata
array
Activation metadata.
Send a POST request to the /api/server/offline-activation-request API endpoint with a JSON request body containing the license key and optionally the activation metadata.
POST
http://localhost:8090/api/server/offline-activation-request
licenseKey
string
License key to activate the server.
metadata
array
Activation metadata.
After generating the offline response from the admin dashboard, send a POST request to the /api/server/offline-activate API endpoint with a JSON request body containing the license key and the offline response.
POST
http://localhost:8090/api/server/offline-activate
licenseKey
string
License key to activate the server.
offlineResponse
string
Offline activation response.
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:
After installation, it is set to start with the computer and run silently in the background.
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):
To uninstall simply pass "-d" option to deactivate the server license and then "-u" option to remove the service:
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:
After installation, it is set to start with the computer and run silently in the background.
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):
To uninstall simply pass "-d" option to deactivate and then "-u" option to remove the daemon:
LexFloatServer runs as a launchd daemon on macOS. To install it as a service simply pass the "-i" option along with the service name:
After installation, it is set to start with the computer and run silently in the background.
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):
To uninstall simply pass "-d" option to deactivate and then "-u" option to remove the daemon:
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
Gets the current server stats
LexFloatServer exposes a license info API endpoint that can be used to get the information related to the license used to activate the LexFloatServer.
GET
http://localhost:8090/api/server/license-info
Gets the license info of the license used to activate the LexFloatServer
LexFloatServer exposes a floating-licenses API endpoint that can be used to get the leased floating licenses.
GET
http://localhost:8090/api/floating-licenses
Gets the current server stats
LexFloatServer exposes a license meter attributes API endpoint that can be used to get the list of all the meter attributes of the license used to activate the LexFloatServer.
GET
http://localhost:8090/api/server/license-meter-attributes
Gets the list of meter attributes of the license used to activate the LexFloatServer