Customizing the FlexNet License Server Manager

Note:This step is optional and only relevant to producers. License server administrators can skip this section.

This section describes the ways in which producers can customize the License Server Manager.

Instead of the Revenera logo, FlexNet License Server Manager can show the logo of the producer organization. For the logo, the following file types are supported: JPG, JPEG, and PNG.
The labels and icons of the navigation menu on the left side can be customized.

Producers edit the Docker container and create a new Docker image. They then distribute the Docker image to their customers who install the License Server Manager as described in the following section, Setting Up the FlexNet License Server Manager.

To customize the FlexNet License Server Manager user interface

1. Change to the directory where the image file is located and run the following command to load the image file:

docker load -i <Flexnet License Server Manager image .zip file>

You will see output similar to the following:

D:\Git\FLSM>docker load -i FlexnetLicenseServerManager-2024-03.zip

7cd52847ad77: Loading layer [==============================================>] 7.338MB/7.338MB

d8a5a02a8c2d: Loading layer [==============================================>] 5.32MB/5.32MB

5e59460a18a3: Loading layer [==============================================>] 3.584kB/3.584kB

152a948bab3b: Loading layer [==============================================>] 4.608kB/4.608kB

c4d67a5827ca: Loading layer [==============================================>] 3.584kB/3.584kB

f1bee861c2ba: Loading layer [==============================================>] 7.168kB/7.168kB

042cd3f87f43: Loading layer [==============================================>] 29.85MB/29.85MB

dd9369c9bea6: Loading layer [==============================================>] 4.096kB/4.096kB

bf8fe155c7b7: Loading layer [==============================================>] 6.38MB/6.38MB

Loaded image: revenera/flsm:2024-03

2. Use the following command to verify the image:

docker images

You will see output similar to the following:

REPOSITORY         TAG         IMAGE ID         CREATED          SIZE

revenera/flsm      2024-03     1c0383a444f7     5 hours ago      49.4MB

revenera/flsm      2023-09     c829323eea31     5 months ago     47.7MB

3. Use a command like the following to run the FlexNet License Server Manager image and to set up the application environment:

docker run -p 8080:80 -e API_PORT=8080 -t revenera/flsm:2024-03

The command above uses the following flags:

-p: Assigns the port configuration. Adjust the port numbers as required for your application environment. The first port is the Docker host and the second port is the port used by the License Server Manager application. The port numbers must be identical.
-e: Sets an environment variable in the container.
-t: Creates a tag that refers to the source image. In the example above, the image name is revenera/flsm and the tag value is 2024-03.

You will see output similar to the following (shortened for brevity):

2024/03/04 11:53:20 [notice] 1#1: using the "epoll" event method

2024/03/04 11:53:20 [notice] 1#1: nginx/1.25.4

2024/03/04 11:53:20 [notice] 1#1: built by gcc 12.2.1 20220924 (Alpine 12.2.1_git20220924-r10)

2024/03/04 11:53:20 [notice] 1#1: OS: Linux 5.10.102.1-microsoft-standard-WSL2

2024/03/04 11:53:20 [notice] 1#1: getrlimit(RLIMIT_NOFILE): 1048576:1048576

2024/03/04 11:53:20 [notice] 1#1: start worker processes

2024/03/04 11:53:20 [notice] 1#1: start worker process 19

2024/03/04 11:53:20 [notice] 1#1: start worker process 20

2024/03/04 11:53:20 [notice] 1#1: start worker process 21

2024/03/04 11:53:20 [notice] 1#1: start worker process 22

2024/03/04 11:53:20 [notice] 1#1: start worker process 23

4. Open a separate command-line terminal and use the following command to locate the ID or name of the active License Server Manager container. (Alternatively, you can copy the ID from the Docker desktop application.)

docker ps

You will see output similar to the following (shortened for brevity):

CONTAINER ID  IMAGE                  COMMAND                 CREATED      STATUS        

8d2b9756f86a  revenera/flsm:2024-03  "/docker-entrypoint.…"  2 weeks ago  Up 7 minutes  

5. You can now perform one or both of the following customizations:
Add a custom logo:

Use the following command to copy the image file for your organization’s logo to the specified path within the running License Server Manager container:

docker cp <path>\logo.jpg <container_ID>:/usr/share/nginx/assets/logo.jpg

Important:Valid names for the logo are logo.jpg, logo.jpeg, or logo.png. If the logo has a different file name or a different extension, Docker returns an error.

You will see output similar to the following:

Successfully copied 37.9kB to 8d2b9756f86a:/usr/share/nginx/assets/logo.jpg

Customize the left navigation menu:

You can edit the labels and icons that appear in the left navigation menu. These labels and icons are specified in a file called data.json. Prepare a custom data.json file where you edit the labels and icons as required. Use the icons from Material UI (see https://mui.com/material-ui/material-icons). Copy the icon name without the suffix; for example, to use the icon PermDataSettingIcon, specify PermDataSetting.

Tip:The Docker container contains a sampleData.json (located under <container_ID>:/usr/share/nginx/assets/) which helps you prepare your custom data.json.

Important:Only edit fields called either “label” or “icon”. Editing any other fields will result in errors.

When you prepared your custom data.json file, use the following command to copy it to the specified path within the running License Server Manager container:

docker cp <path>\data.json <container_ID>:/usr/share/nginx/assets/data.json

You will see output similar to the following:

Successfully copied 37.9kB to 8d2b9756f86a:/usr/share/nginx/assets/data.json

6. Commit the changes made to the License Server Manager container to create a new Docker image with the updated logo:

docker commit <container_ID> <image>:<tag>

where <container_ID> is the ID output by the docker ps command (see Step 4), and <image>:<tag> is the name of the new Docker image and tag, for example:

docker commit 8d2b9756f86a revenera/flsm-custom:2024-03

You will see output similar to the following:

sha256:7272b5523871c7d4f61b91b358613f8d20dacc5dc352ff6790023bf0a13b4c26

7. Use the following command to verify the new image:

docker images 

You will see output similar to the following:

REPOSITORY                   TAG         IMAGE ID         CREATED               SIZE

revenera/flsm-custom         2024-03     20413816ea62     About a minute ago    49.5MB

revenera/flsm                2024-03     1c0383a444f7     5 hours ago           49.4MB

revenera/flsm                2023-09     c829323eea31     5 months ago          47.7MB

8. Optionally, use the following command to save the image as a zip file:

docker save -o <file_name>.zip image_name:<tag>

You can now distribute the customized Docker image or zip to your customers.

To install the customized License Server Manager, the license server administrator needs to perform the steps as described in the following section, Setting Up the FlexNet License Server Manager.