Floating License Server Help

Commands reference

The main script for managing Floating License Server (FLS) is license-server.sh, which is located under /bin in the FLS installation directory. To see all available commands for the script, change to the FLS installation directory and run the script with the help command (or with no command):

./bin/license-server.sh help
  • To start, stop, and restart FLS, use the service JetBrains License Service.

    The service can be controlled using the Services snap-in for Microsoft Management Console (MMC). The list of Windows services is usually available in the Control Panel under Administrative Tools, and this requires administrator privileges.

    Alternatively, you can control Windows services from the command line locally using sc.exe. There are also PowerShell cmdlets to perform service management.

  • To configure FLS, use the management script license-service.bat in the FLS installation directory. For more information about using the script, see Commands reference.

    You can use the script to start and stop FLS, but in this case the server will run under current user and stop when the user's session ends.

    There are two similar license-server.bat scripts located under different directories in the FLS installation directory. The first is located under .\bin and it configures the MSI bundle of the FLS application. The second is located under .\app\license-server\bin and configures an application itself. Each procedure in this documentation has instructions on what script should you use.

To see all available commands for the script, change to the FLS installation directory and run the script with the help command (or with no command):

.\bin\license-server.bat help

The output contains a list of FLS commands with their short descriptions. For more information about a command, run help on that command. For example, if you want more information about the configure command, run the following:

./bin/license-server.sh help configure
.\bin\license-server.bat help configure

Command

Description

help

Prints usage text for the specified command.

start

Starts FLS in the background.

  • start soft starts FLS in the background softly (no timeout applied in this case).

run

Runs FLS in the current console.

stop

Stops FLS.

  • stop soft Stops FLS in the background softly (no timeout applied in this case).

restart

Restarts FLS in the background.

  • restart soft restarts FLS in the background using stop soft and start soft.

rerun

Reruns FLS in the current console.

  • rerun soft reruns FLS in the current console using stop soft and run.

status

Prints the full status of JetBrains License Service (exits with code 0 if JetBrains License Service is alive, 1 otherwise).

  • status short prints a short and parsable JetBrains License Service status.

configure

Configures FLS properties and JVM options.

  • --<property name>=<property value> or --<property name> <property value> changes the value of the specified property. To more information, see Configuration properties.

  • -f <properties file path> reads the properties from the specified file and applies its values.

  • -J<JVM option> adds the specified JVM option to the list of options used by the JVM that runs FLS. For more information, see comments in the ./conf/license-server.jvmoptions.\conf\license-server.jvmoptions file. For example, to change the maximum Java heap size to 1024m, set the -J-Xmx1024m property.

  • --J<JVM option> specifies the ad-hoc JVM options.

  • --launcher configures the launcher only and does not pass the specified properties to FLS.

dump

Provides FLS debug info.

  • dump threads dumps FLS threads to the console.

  • dump threads to-file dumps FLS threads to the file under the /logs directory.

  • dump threads to-file short same as dump threads to-file, but prints to the console nothing but the absolute path of the created file.

  • dump heap dumps FLS heap to the file under the /logs directory.

  • dump heap short same as dump heap, but prints to the console nothing but the absolute path of the created file.

kill

Kills the JetBrains License Service process.

daemon

Manages the FLS daemon. Run this command as the root user or with superuser privileges (sudo).

  • daemon configure same as the configure command.

  • daemon install installs the FLS daemon to be run under the previously remembered user or under the root user by default.

  • daemon install --user=<user> or daemon install --user <user> remembers the specified user and installs FLS daemon to be run under this account.

  • daemon install --force uninstalls the daemon first if it already exists.

  • daemon start loads the FLS daemon and starts it.

  • daemon status same as the status command.

  • daemon stop stops the FLS daemon and unloads it.

  • daemon restart reloads and restarts the FLS daemon.

  • daemon uninstall uninstalls the FLS daemon.

java

Manages the path to Java for running FLS. To specify JVM options, use the configure command.

  • java print finds the java executable set to run FLS and prints it to the console.

  • java set <path> sets the specified path as the location of the java executable for running FLS if it has the proper version and attributes.

  • java reset resets the explicitly set Java path for FLS.

Configuration properties

The configure command is used in most procedures for managing FLS. Usually, you need to set the required value for one of the configuration properties.

Property

Description

--listen

Specifies the host (IP address or domain name) where FLS runs. By default, it is 0.0.0.0. See Configuring host and port.

--port

Specifies the port where FLS runs. By default, it is 8080. See Configuring host and port.

--context

Specifies a custom URI for accessing FLS on the host machine if it has other services. See Custom context path.

--jb.license-server.base-dir

Specifies the location of the FLS data directory. See Configuring data directory.

--jetty.virtualHosts.names

Specifies the reverse proxy server host name. See Reverse proxy.

--access.config

Specifies the path to the user restrictions file access-config.json. See User restrictions.

--reporting.out.of.license.threshold

Specifies the threshold for sending email notifications about the lack of available licences. See Lack of available licenses notification.

--reporting.token

Configures a secret key for statistic access. See Statistics via API.

--smtp.server

Specifies the host name of the mail server for sending email statistics. See Emailed statistics.

--smtp.server.port

Specifies the port of the mail server for sending email statistics. See Emailed statistics.

--stats.recipients

Specifies who should receive the email reports. See Emailed statistics.

--stats.from

Specifies the sender of the email report. See Emailed statistics.

--smtp.server.username

Specifies the username for accessing the mail server. See Emailed statistics.

--smtp.server.password

Specifies the password for accessing the mail server. See Emailed statistics.

The following table lists properties applicable to .\bin\license-server.bat, which configures the MSI bundle of the FLS application.

Property

Description

--base-url

Specifies the host (IP address or domain name) and a custom URI where FLS runs. By default, it is 127.0.0.1 with no additional URI. See Configuring host and port.

--listen-port

Specifies the port where FLS runs. By default, it is 80. See Configuring host and port.

--virtual-hosts

Specifies the names of the hosts that will send requests to FLS for Host header validation. See Reverse proxy.

--virtual-hosts-default

Specifies the list of default virtual hosts for Host header validation. See Reverse proxy.

The following table lists properties applicable to .\app\license-server\bin\license-server.bat, which configures the FLS application itself.

Property

Description

--jb.license-server.base-dir

Specifies the location of the FLS data directory. See Configuring data directory.

--access.config

Specifies the path to the user restrictions file access-config.json. See User restrictions.

--reporting.out.of.license.threshold

Specifies the threshold for sending email notifications about the lack of available licences. See Lack of available licenses notification.

--reporting.token

Configures a secret key for statistic access. See Statistics via API.

--smtp.server

Specifies the host name of the mail server for sending email statistics. See Emailed statistics.

--smtp.server.port

Specifies the port of the mail server for sending email statistics. See Emailed statistics.

--stats.recipients

Specifies who should receive the email reports. See Emailed statistics.

--stats.from

Specifies the sender of the email report. See Emailed statistics.

--smtp.server.username

Specifies the username for accessing the mail server. See Emailed statistics.

--smtp.server.password

Specifies the password for accessing the mail server. See Emailed statistics.

Last modified: 5 December 2019