Versions Compared

Old Version 18

changes.mady.by.user Tracy McCurdy

Saved on

compared with

New Version Current

changes.mady.by.user Tracy McCurdy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

By default, a new YAML configuration file will be created automatically after installing and running v6.0 or newer.

As of v6.0, legacy configuration files from LM-X versions prior to v6.0 will no longer work. If you use an existing configuration file from an older version when you start up the license server in v6.0 or newer, the configuration file will be migrated to the new YAML format.

The old configuration file does not include settings for the web server used to run the new LM-X License Server UI. To enable the web server and access the LM-X License Server UI, you must manually add the following lines to the newly migrated configuration file:

web_server:
  tcp_listen_port: 6199

After adding these lines to the configuration file and restarting the LM-X server, you can access the LM-X License Server UI at  at https://URL:6199.

This page details all LM-X license server configuration settings, their valid values, and required YAML syntax.  

...

Info

Note the following:

  • Configuration Changes: All settings can be modified either directly in the configuration file or by using the LM-X License Server UI. However, any changes will only be applied after a restart of the license server.

  • Admin User Management: The web server configuration must include an admin user. If the admin user is missing in the configuration, it will be automatically recreated using the default password admin.  This This default password can be changed later using the LM-X License Server UI.

  • YAML Syntax: As of LM-X License Manager v6.0, the LM-X license server configuration is defined using YAML. Ensure you use proper YAML formatting, including indentation and case sensitivity for keys. Incorrect syntax may lead to configuration errors or server misbehavior. To avoid errors, using the LM-X License Server UI is recommended.

Anchor
lic serverlicserverlic server
licserver
License server settings

The license_server settings configure the TCP port and bind addresses for the license server. The license_server settings are detailed below. 

...

  • Description: A mapping of user credentials required for accessing the UI.
  • Mandatory Admin User:
    • An admin user must exist for the UI to function.
    • Behavior: If the admin user is missing from the configuration, it will be automatically recreated with the default password "admin". This password can be changed via the the LM-X License Server UI.
  • Example syntax:
    web_server:
  tcp_listen_port: 6199
  users:
    admin:
      password: '$argon2id$v=19$m=65536,t=3,p=4$PVbKB+ekhE0ZBJ/2z1ggwQ==$+PjvNqhTnRlCxtApKJqq6kFYfPlR5QFVaXN5jEaT5t4='
      role: admin

...

borrow:
  access:
    - feature: 'f1'
      allow:
        users:
          - 'bob'
          - 'alice'
    - feature: 'f2'
      allow:
        hosts:
          - 'localhost'
        ip_addresses:
          - '1.1.*.*'
    - feature: '*'
      allow:
        users:
          - 'test'
    - feature: 'f3'
      deny:
        users:
          - 'bob'
          - 'alice'
  limit:
    - feature: 'f5'
      hours: 3
    - feature: 'f1'
      count: 6
      ignore:
        users:
          - 'bob'
    - feature: 'f3'
      hours: 3
      ignore:
        hosts:
          - 'host666'
    - feature: '*'
      count: 1
      ignore:
        ip_addresses:
          - '123.123.123.123'

Anchor
licenses
licenses
License file settings

The licenses settings define where the license server searches for license files and optionally let you embed license data within the configuration.

...