Commands reference
The main script for managing 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):
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:
The main script for managing 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):
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:
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 License Server 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):
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:
Command | Description |
---|---|
| Prints usage text for the specified command. |
| Starts FLS in the background.
|
| Runs FLS in the current console. |
| Stops FLS.
|
| Restarts FLS in the background.
|
| Reruns FLS in the current console.
|
| Prints the full status of JetBrains License Service (exits with code 0 if JetBrains License Service is alive, 1 otherwise).
|
| Configures FLS properties and JVM options.
|
| Provides FLS debug info.
|
| Kills the JetBrains License Service process. |
| Manages the path to Java for running FLS. To specify JVM options, use the
|
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 |
---|---|
| Specifies the host (IP address or domain name) where FLS runs. By default, it is |
| Specifies the port where FLS runs. By default, it is |
| Specifies a custom URI for accessing FLS on the host machine if it has other services. See Custom context path. |
| Specifies the location of the FLS data directory. See Configuring data directory. |
| Specifies the reverse proxy server host name. See Reverse proxy. |
| Specifies the path to the user restrictions file access-config.json. See User restrictions. |
| Specifies the threshold for sending email notifications about the lack of available licences. See Lack of available licenses notification. |
| Configures a secret key for statistic access. See Statistics via API. |
| Specifies the host name of the mail server for sending email statistics. See Emailed statistics. |
| Specifies the port of the mail server for sending email statistics. See Emailed statistics. |
| Specifies who should receive the email reports. See Emailed statistics. |
| Specifies the sender of the email report. See Emailed statistics. |
| Specifies the username for accessing the mail server. See Emailed statistics. |
| Specifies the password for accessing the mail server. See Emailed statistics. |
Property | Description |
---|---|
| Specifies the host (IP address or domain name) where FLS runs. By default, it is |
| Specifies the port where FLS runs. By default, it is |
| Specifies a custom URI for accessing FLS on the host machine if it has other services. See Custom context path. |
| Specifies the location of the FLS data directory. See Configuring data directory. |
| Specifies the reverse proxy server host name. See Reverse proxy. |
| Specifies the path to the user restrictions file access-config.json. See User restrictions. |
| Specifies the threshold for sending email notifications about the lack of available licences. See Lack of available licenses notification. |
| Configures a secret key for statistic access. See Statistics via API. |
| Specifies the host name of the mail server for sending email statistics. See Emailed statistics. |
| Specifies the port of the mail server for sending email statistics. See Emailed statistics. |
| Specifies who should receive the email reports. See Emailed statistics. |
| Specifies the sender of the email report. See Emailed statistics. |
| Specifies the username for accessing the mail server. See Emailed statistics. |
| 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 |
---|---|
| Specifies the host (IP address or domain name) and a custom URI where FLS runs. By default, it is |
| Specifies the port where FLS runs. By default, it is |
| Specifies the names of the hosts that will send requests to FLS for |
| Specifies the list of default virtual hosts for |
The following table lists properties applicable to .\app\license-server\bin\license-server.bat, which configures the FLS application itself.
Property | Description |
---|---|
| Specifies the location of the FLS data directory. See Configuring data directory. |
| Specifies the path to the user restrictions file access-config.json. See User restrictions. |
| Specifies the threshold for sending email notifications about the lack of available licences. See Lack of available licenses notification. |
| Configures a secret key for statistic access. See Statistics via API. |
| Specifies the host name of the mail server for sending email statistics. See Emailed statistics. |
| Specifies the port of the mail server for sending email statistics. See Emailed statistics. |
| Specifies who should receive the email reports. See Emailed statistics. |
| Specifies the sender of the email report. See Emailed statistics. |
| Specifies the username for accessing the mail server. See Emailed statistics. |
| Specifies the password for accessing the mail server. See Emailed statistics. |