Successfully!

Error!

Local Container Authentication

  • Last update:  2024-02-01
  • Overview

    Version

    Report Server Version

    Functional Change

    11.0

    /

    11.0.20

    Added a strong reminder to re-register after the project restarts.

    Demo Video

    Application Scenarios

    Local container authentication is designed for scenarios where there is no fixed server or the server frequently changes, such as the private cloud server and virtual server.

    • No fixed machine information: Local machine information authentication is invalid for virtual machine or Docker as the machine information changes everytime the machine is restarted.

    • Public cloud authentication cannot be used if the report project is deployed in an intranet environment.

    • Private cloud authentication cannot be used if there is no license server with unchanged physical information.

    Functions

    You can use your mobile phone as a medium to perform local container authentication. The authorization process is shown in the following figure.

     

    Notes

    Local container authentication:

    1. Report projects (the JAR package last modified on or after 2021/10/30) are supported in local container authentication.

    2. Report projects can be authenticated through local container, which are not limited by physical information. That is to say, changes in physical information do not cause registration failures.

    3. You need a mobile phone that can communicate with extranet environment, but do not need to enable extranet access to your report server.

    4. Reauthentication is required after the report server restarts. You are not required to re-upload the Container.lic file, just re-scan the QR code and enter the verification code. For details, see section "Scanning the QR Code."

    5. One authorization for one report project

    Local container authentication for clusters:

    1. Cluster registration prices fluctuate based on the maximum number of registration (the number of required cluster nodes).

    2. If the number of cluster nodes exceeds the maximum number of registration, registration fails.

    3. Before you register the cluster project, ensure that the time of each server is consistent.

    4. If all nodes in the cluster are restarted, the report project needs to be re-authenticated. You are not required to re-upload the Container.lic file, just re-scan the QR code and enter the verification code. For details, see the Scanning the QR Code section.

    Registration Procedures

    Obtaining the Authorization 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 the business personnel receive the email and verifies it, they generate the Container.lic file and email it to you.

    iconNote:

    Indicate the special circumstances (if any) in the email.


    Preparation

    Requirement

    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.

    If you do not use the email address specified in the contract to send registration information, the registration will not be allowed.

    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 not be allowed.

    Body

    Basic information

    Company name: Company Name

    Project name: Project Name

    Contract signing date: YYYY/MM/DD

    /

    Registration method

    Local Container Authentication

    /

    Maximum number of registration

    Number of nodes in the cluster project

    If this option is not provided, the number defaults to 1.

    It is not required in a single-node environment.

    Project Version

    Specify the minor project version and the JAR package version, which can be found in System Management > Registration Management > Version Information.

    /

    Uploading the LIC File

    Log in to the decision-making platform as the admin, choose System Management > Registration Management, and click Register Now.

     

    Select Local Container as AUTH Method, click Upload License, and upload the Container.lic file sent by the business personnel in email. After successful uploading, an authentication QR code is generated. 

     

    Scanning the QR Code

    Scan the generated QR code through a mobile browser to obtain a 6-digit verification code. Fill in the verification code in the system and click Submit.

    iconNote:

    1. 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.

    2. You'd better register the project immediately after getting the verification code and do not restart the project until the registration is successful.

    3. If the number of incorrect verification code inputs exceeds five times, it will be locked for 15 minutes to prevent brute force attack and high-frequency access to the interface.


    Registration takes effect after successful authentication.

     

    Migrating Registration Information

    Each Container.lic file sent by the business personnel can only be registered in one report project.

    To replace the report project server, contact the business personnel to cancel the registration license of the old server. Then the new server can be registered through the same Container.lic file.

    iconNote:
     If the license registered on the old server is not unbound, you cannot register on the new server. It will prompt "The maximum license number has been reached."


    Re-registration After Restarting the Project

    After project restart, local container authentication will turn to be invalid. In this case, you need to re-scan the QR code for re-registration. To prevent administrators from forgetting, the strong reminder function is added in FineReport V11.0.20 and later versions.

    1. After the project restarts, log in to the decision-making platform as admin with the permission of Registration Management. A prompt pops up, indicating that Your project registration has expired due to project restart. Enter registration management and authenticate again.

    2. Click the Authenticate button to jump to the Registration Management page.

    3. Click the Re-register button. Then the authentication information QR code is displayed. Scan the QR code with your phone to receive the verification code.

    4. Enter the verification code and click Submit. Then re-registration is successful.

     

    Failed Registration

    Problem

    If registration fails, a prompt window pops up.

     

    Summary of Causes

    Click Details to view causes for the failed registration. You can troubleshoot according to the specific cause.


    Cause

    Specific Prompt

    License Expired

    Expiration date: 2019/02/22

    Version Mismatch

    Certified application version : 9.0

    Local application version : 10.0

    App Name Mismatch

    Authentication application name: Application name

    Local application name: Application name

    License Exhausted

    Cluster nodes exceed the maximum number of nodes that can be registered through the license.

    Project Content Mismatch

    Authentication project content: Content

    Local project content: Content

    License Type/Version Mismatch

    The selected authentication method does not match the uploaded license type.

    iconNote:
    In addition to the above causes, other errors are reported uniformly: License content is incorrect.
    Multiple causes (if any) are displayed on the platform.



     


    Attachment List


    Theme: Deployment and Integration
    Already the First
    Already the Last
    • Helpful
    • Not helpful
    • Only read

    Doc Feedback