New Project Registration

Version 

Function Description 

You can choose a suitable registration method as needed for FanRuan projects that require registration and authorization.

Notes 

The authorization component you install according to this document cannot be stopped or restarted. Otherwise, re-authentication is required.

During re-authentication (if required), you just need to re-scan the QR code and enter the verification code, rather than re-uploading the image file.

Obtaining the License Image 

Use the email address specified in the contract and send the registration information to FineReport business personnel (business@fanruan.com). The email format is shown as follows.

After receiving the email and verifying the information, the business personnel will generate an image file named fanruan_license_server.tar of the authentication server and email the file to you.

Note:

Specify the special requirements (if any) in the email.

Information		Requiremrnt	Notes
Contact		Contact FanRuan sales personnel in advance to confirm relevant matters and sign the contract.
Sender		Use the email address specified in the contract.	Otherwise, the registration will be rejected.
Recipient		business@fanruan.com	/
Title		Official Authorization Document of Company Name's Registration for FineReport	If you do not mark the company name in the email, the registration will be rejected.
Body	Basic Information	Company name: Company Name Project name: Project name Contract signing date: YYYY/MM/DD	/
	Registration Method	Container private cloud authentication	/
	Maximum Number of Registrations	The number of nodes in the cluster project (For FineBI 6.1 projects, it refers to the number of FineBI - Application Node components.)	You do not need to provide information about this item for standalone projects. If the information is not provided, the number will default to 1. If the number you provide exceeds that specified in the contract, the latter shall prevail.
	Number of BI Engines	For FineBI 6.1 license application, specify the number of the Engine - Calculation Node components. Note: You can check the number of engines under System Management > System Setting > Engine Cluster Management. It equals the total number of nodes minus one.	In the absence of this information, the number shall default to that specified in the contract or, failing which, 1. If the number you provide exceeds that specified in the contract, the latter shall prevail.
Attachment	Project Version	Log in to the FineBI system as the admin, choose System Management > Registration Management > Version Information, capture a full-page screenshot, and include it as an attachment.
	BI Engine Information	For FineBI 6.1 license application, log in to the FineBI system as the admin, choose System Management > System Setting > Engine Cluster Management, capture a full-page screenshot, and include it as an attachment.

Preparing a Registration Port 

Using the container private cloud for authentication requires uploading the license image to the O&M project and enabling it.

• If there is no component server in the O&M project, you can deploy the authorization component on the main application server.

• If there is a component server in the O&M project, you must deploy the authorization component on the component server.

Designate a free port on the corresponding server for the authorization component. (This example uses port 18081.)

Ensure the port is accessible from the project server via the internal network.

For details about port occupancy inspection and firewall configuration, see Port Occupancy Inspection and Firewall Configuration.

Deploying the Authorization Application 

1. Log in to FineOps as the admin, select the O&M project, and choose Maintenance > Component Management.

2. Click Project Registration, upload the obtained license image, select the node, and set the port to the prepared one.

Note:

When deploying the authorization component, ensure that no License Server component exists in the project. Otherwise, the Register Project button will not appear.

If such a component is present, contact FanRuan technical support personnel for assistance. For details about how to contact technical support, see Technical Support Channel Introduction.

3. Click Deploy. After completing the deployment, access the provided address and scan the code for registration.

Make a note of the address, which is in the form of https://IP address:Port number/license/qrcode. (The IP address and the port number are those specified in the Preparing a Registration Port section.)

Scanning the Code for Authentication 

1. Access the obtained QR code address.

2. Scan the generated QR code through a mobile browser, and enter the returned 6-digit verification code.

3. Submit the verification code. It will prompt a successful verification if the authentication is successful.

Note:

The QR code is valid for five minutes. Ensure that the registration is completed within the specified time. Refresh the QR code manually if the registration takes more than 5 minutes. 

Note 2: If the number of incorrect inputs of the verification code exceeds five, it will be locked for 15 minutes to prevent brute force attacks and high-frequency access to the page.

Note 3: You'd better register the FanRuan application immediately after getting the verification code and do not restart it until the registration is successful.

Registering the Project 

1. Log in to the FanRuan application as the admin, choose System Management > Registration Management, and click Register Now.

2. Set Authentication Method to Private Cloud.

3. Enter the IP address and port number of the authorization application, such as https://192.168.220.122:18081/.

4. Click Submit. The following figure shows the page after successful authentication.

Note:

If authentication fails, check firewall settings, open corresponding ports, or disable the firewall.

License migration is divided into two scenarios:

• Project change: When the original project is deauthorized and replaced with a new one, the new project needs to be authorized.

• Authorization component change: When it's necessary to redeploy the authorization component, you need to obtain and install the license image again and reauthorize the project.

Note:

Executing a docker run command for the authorization component effectively redeploys it. Follow the steps in the "Migrating the Authorization Component" section.

If you have already performed the docker run operation before unbinding the license, ensure you restart the authorization component after the unbinding operation completes successfully.

Migrating the Project License

If the authorization component remains unchanged, you only need to deauthorize the original project and apply the license to the new project. Proceed as follows.

1. Deauthorize the old project.

Log in to the FanRuan project as the admin, choose System Management > Registration Management, and click Re-register.

2. Scan the QR code to authorize the new project.

Perform operations described in Scanning the Code for Authentication and Registering the Project for the new project.

Migrating the Authorization Component

Proceed as follows if you need to redeploy the authorization component.

Destroying the Old Authorization Component

• Use the email address specified in the contract and send the registration information to FineBI business personnel (business@fanruan.com) when the authorization component can be started up normally.

• Describe the address of the authorization server to be migrated (such as https://192.168.101.46:18081/)  clearly in the email body.

• Business personnel will destroy the corresponding license and notify you by email after receiving and verifying the email.

Note:

Do not restart the authorization component to be migrated or the corresponding project until you receive a clear response from the business personnel.

Copying the privateConfig File

1. Record the container name of the License Server component.

Locate the License Server component under Maintenance > Component Management, click the  icon to enter the terminal, and record the container name.

In this example, the container name is fanruan240727164101_license_server.

2. Stop the License Server component.

Stop the License Server component to be migrated under Maintenance > Component Management.

3. Copy the privateConfig file and paste it into the host machine.

Log in to the server hosting the License Server component using a terminal. Copy the privateConfig file that was automatically generated in the /app/config path of the container to the specified path on the host machine using the following command: 

docker cp Obtained container name:/app/config/privateConfig/Path of the target folder

For example, copy the file and paste it into the /home/fanruan path: 

docker cp fanruan240727164101_license_server:/app/config/privateConfig /home/fanruan

Obtaining the Image of the New Authorization Component

• Use the email address specified in the contract and send the registration information to FineBI business personnel (business@fanruan.com).

• For details about the email format, see the Obtaining Authorization File section. You need to attach the privateConfig file obtained in the previous step.

• After receiving the email and verifying the information, the business personnel will generate an image file named fanruan_license_server.tar of the authentication server and email the file to you.

Redeploying the Authorization Component and Authorizing the Project

Deploy the new authorization component following the steps in the Registration Procedure section, and register the project accordingly.

Note:

When redeploying the authorization component, ensure that no License Server component exists in the project. Otherwise, the Register Project button will not appear.

If such a component is present, contact FanRuan technical support personnel for assistance. For details about how to contact technical support, see Technical Support Channel Introduction.