Private Cloud Authentication

Version

Application Scenarios

The report server is deployed on a virtual machine or a cloud platform, so the physical information of the report server is not fixed and cannot be bound. Therefore, local machine information authentication is no longer applicable.

In this case, you need to find a server with fixed physical information as the license server, and send the RIF file (machine information of the license server) to FanRuan business team to generate a private cloud authentication server file FanruanLicenseServer, which contains a server.exe file.

Functions

When the physical information of the report server is not fixed and cannot be authenticated through local machine authentication, private cloud authentication is applicable if there is a server with fixed physical information.

The license server (License Server in the following figure) returns information like function points, domain name, port number, app name, and expiration date of the license to the report server (Business Server in the following figure).

The report server (Business Server in the following figure) performs the verification. If the information passes verification, the report server can access normally; otherwise, it cannot get license.

The license server program refers to the server program that provides authorization functions. (Physical information needs to be provided.) The report server refers to a server where FineReport is running. (Physical information is not required.)

Notes

1. The license server for private cloud authentication must be a machine with fixed physical information. The machine where the report server is running does not need to be with fixed physical information.

For example, physical information may change in a virtual machine environment, causing registration failure, which is not suitable to be used as a license server.

2. The report server is the server where the report project to be registered is located, and it needs to be connected with the license server through network.

3. Two private cloud authentication programs cannot run on the same license server.

4. If the machine needs to serve as a license server again after uninstallation, you need to generate the MachineInfo.rif file again and send it to FanRuan business team for re-registration.

5. One license server can authorize multiple report servers within the maximum number of registrations.

6. If you use private cloud authentication in a cluster environment, you do not need to send registration information on every node.

7. You do not need to apply for the license file again to migrate the report server. 

• When applying for a license, you can specify the IP range of the report server instead of specifying a specific IP.

• Ensure that the machine where the report server is located can connect with the license server through network, and the  IP of the new report server is within the specified IP range.

8. Systems i386, ARM, and AMD64 are supported on Linux.

9. Accessing private cloud through Network Address Translation (NAT) is not supported.

10. The authentication program of the license server cannot keep closed for more than 24 hours.

• If the server has been closed for more than 24 hours, the report server will prompt failure to register and reconnect to the license server within two hours. The registration will not expire.

• If the program has been closed for more than 24 hours, you need to restart the authentication program and re-register for the report server.

11. The report server will send a request to the license server every two hours. The license server will send feedbacks to the report server after receiving the requests.

If the report server has not received feedbacks for 12 consecutive times (24 consecutive hours), or the authentication server has not received requests for 24 consecutive hours, the report server registration will fail, and you need to re-register.

In FineReport V11.0.18 and later versions, the registration failure time and reasons will be displayed in a table in System Management > Registration Management > Version Information > Registration Information to help you troubleshoot problems.

Note:

In a cluster environment, the failure reasons may vary in different nodes, and the failure reasons for each node will be displayed.

Downloading the Machine Tool

You can download the machine tool for obtaining the license server information file: Windows.zip

Upload the compressed package to the license server and uncompress it.

Exporting License Server Information

Run the generated machine.exe file as the admin to automatically generate the require folder in the same directory.

The MachineInfo.rif file in the require folder is the exported license server information file.

Getting the License File

Use the email address specified in the contract and send the registration information to FineReport business personnel (business@fanruan.com) who will assist in generating the license. It may take a while. This method is applied to all FanRuan projects. The email format is shown as follows.

After confirmation, the business personnel will send the FanruanLicenseServer.zip license file to your email.

Note:

If there are any problems, describe them in the email.

Starting the License Server

Uncompress the FanruanLicenseServer.zip file sent by FanRuan on the license server.

Run the server.exe file in the bin directory as the admin.

Note:

1. If the startup fails and the reason for the error is that the port is occupied, add the parameter -port to specify another port in the start command.

Example: .server.exe -port 8088

2. The server.exe file obtained after October 13, 2021 allows selecting languages during the license server startup. English and Simplified Chinese are available.

Start command example: .server.exe -port 8088 -language en

Setting Automatic Start During Server Startup

The server.exe file of the license server on Windows cannot be closed. If the program is closed, when you open it again, the server is not registered, and you need to repeat steps in the Starting License Server section.

Set automatic start of the server.exe file in \FanruanLicenseServer\bin during server startup manually.

Note:

After setting, the program will automatically start during the server startup. If you need to change private cloud, end the previous private cloud.

Report Server Verifying the License

The report projects are deployed on the report server. Log in to the decision-making platform as the admin, choose System Management > Registration Information > Version Information, and click Register Now.

Select Private Cloud in AUTH Method. Enter the IP address and listening port number of the license server in Server Address, for example, https://172.16.63.131:8081, and click Submit.

Note:

1. If you have provided the license server domain name, enter the domain name. If not, enter the IP address.

2. Ensure that the report server can access the license server.

The successful authentication interface is shown in the following figure.

Note:

1. Max Connections refers to the maximum number of projects that can apply to the license server for registration simultaneously.

2. If the authentication fails, check the firewall settings and open the corresponding port or disable the firewall.

Downloading the Machine Tool

Click it to download the machine tool for obtaining the license server information file.

Note:

Generally, AMD64 is applicable to Linux of 64-bit, and i386 to 32-bit.

The use of ARM architecture depends on hardware in the machine. For example, if RISC (Reduced Instruction Set Computer) and CPU with low-power consumption are used in the physical machine, you can select ARM architecture.

Exporting License Server Information

Note:

In this section, you need to log in to the system as the admin, otherwise, there will be an error during the license program startup saying "Machine Code Mismatch".

Take Linux_amd64 as an example.

Upload the compressed package to the license server and uncompress it to generate the machine.file file.

unzip linux_amd64.zip

Add permissions to the machine.file file.

chmod 777 machine

Run the machine.file file. The license server information file (the MachineInfo.rif file in the require directory) will be automatically generated.

./machine

Getting the License File

Use the email address specified in the contract and send the registration information to FineReport business personnel (business@fanruan.com) who will assist in generating the license. It may take a while. This method is applied to all FanRuan projects. The email format is shown as follows.

After confirmation, the business personnel will send the FanruanLicenseServer.zip license file to your email.

Note:

If there are any problems, describe them in the email.

Starting the License Server

Note:

If you use tools for connection, after executing the nohup ./bin/server & command, use exit to log out.

After login again, you can use the ps -ef|grep server command to check whether it is running in the backend. If it is running, private cloud has started in the backend and will keep running unless the server is closed.

1. Uncompress the FanruanLicenseServer.zip package sent by FanRuan on the registrations server.

unzip FanruanLicenseServer.zip

2. After you uncompress the package, run the server file in the bin directory as the admin.

nohup ./server &

Note:

You can select English or Simplified Chinese during the license server startup.

Start command example: ./server -language en

3. The successful startup of the license server is shown in the following figure.

Report Server Verifying the License

The report projects are deployed on the report server. Log in to the decision-making platform as the admin, choose System Management > Registration Information > Version Information, and click Register Now.

Select Private Cloud in AUTH Method. Enter the IP address and listening port number of the license server in Server Address, for example, https://172.16.63.131:8081, and click Submit.

Note:

1. If you have provided the license server domain name, enter the domain name. If not, enter the IP address.

2. Ensure that the report server can access the license server.

The successful authentication interface is shown in the following figure.

Note:

1. Max Connections refers to the maximum number of projects that can apply to the license server for registration simultaneously.

2. If the authentication fails, check the firewall settings and open the corresponding port or disable the firewall.

Downloading the Machine Tool

You can download the machine tool for obtaining the license server information file: Mac.zip

Exporting License Server Information

Upload the compressed package to the license server and uncompress it to generate the machine.file file.

unzip Mac.zip

Add permissions to the machine.file file.

chmod 777 machine

Run the machine.file file. The license server information file (the MachineInfo.rif file in the require directory) will be automatically generated.

./machine

Getting the License File

Use the email address specified in the contract and send the registration information to FineReport business personnel (business@fanruan.com) who will assist in generating the license. It may take a while. This method is applied to all FanRuan projects. The email format is shown as follows.

After confirmation, the business personnel will send the FanruanLicenseServer.zip license file to your email.

Note:

If there are any problems, describe them in the email.

Starting the License Server

Note:

The executable file running on the license server (the server file) cannot be closed.

Uncompress the FanruanLicenseServer.zip file sent by FanRuan on the license server.

Run the server file in the bin directory as the admin.

Note:

You can select English or Simplified Chinese during the license server startup.

Start command example: ./server -language en

Report Server Verifying the License

The report projects are deployed on the report server. Log in to the decision-making platform as the admin, choose System Management > Registration Information > Version Information, and click Register Now.

Select Private Cloud in AUTH Method. Enter the IP address and listening port number of the license server in Server Address, for example, https://172.16.63.131:8081, and click Submit.

Note:

1. If you have provided the license server domain name, enter the domain name. If not, enter the IP address.

2. Ensure that the report server can access the license server.

The successful authentication interface is shown in the following figure.

Note:

1. Max Connections refers to the maximum number of projects that can apply to the license server for registration simultaneously.

2. If the authentication fails, check the firewall settings and open the corresponding port or disable the firewall.

In FineReport earlier than V 11.0.18, if the registration fails, there will be a pop-up window: Failed. Please authenticate again.

FineReport 11.0.18 and later versions optimized the registration failure prompt. If the registration fails, the pop-up window will prompt the specific failure reasons to help you troubleshoot problems.

Standalone Environment Registration Failure

If registration fails, there will be a pop-up window prompting the specific failure reasons. Click Details to view the specific reasons or troubleshooting solutions.

Click Back to return to the registration interface. Registration Failed and Failure Reason are provided in Registration Information. Click View Error Details to see specific reasons and troubleshooting solutions.

Cluster Environment Registration Failure

The reasons for registration failure may vary in different nodes. There will be a pop-up window prompting failure reasons of every node. Click Details to see specific reasons or troubleshooting solutions.

Click Back to return to the registration interface. Failure reasons of every node are listed in a table in Registration Information. Click View Error Details to see the failure reasons or troubleshooting solutions.

Failure Reason

Registration failure reasons are shown in the following table. You can troubleshoot according to the reasons and solutions.

Note:

1. Reasons other than the following ones will lead to the same error: The certificate content is incorrect.

2. When there are multiple reasons, only the first one will be displayed.

Destroying the License

Destroy the current license server. Go to the bin directory as the admin and run the file.

On Windows

On Windows system, open the command prompt (cmd), go to the bin directory, and run the following command.

.\server.exe -destroy

On Mac and Linux

On Mac and Linux system, the command is as follows.

.\server.exe -destroy

Getting the Destruction Evidence File

Execute the command. The authentication of the current server will be destroyed, and you will get a file proving destruction.

Note:

Sometimes Windows may report error. In this case, you have to create a folder named uninstall of the same level of the bin folder. The evidence file will be in the uninstall folder.

Re-registration

Send the two files below to FanRuan business team:

The receipt.fr file and the MachineInfo.rif file (regenerated by application for the license server).

After confirmation, FanRuan will send a new license file to your email.

Note:

After destruction, if you restart the report server, the registration will fail. If you do not restart the report server, the registration will fail in about 24 hours.