私有雲認證

1.1 版本

1.2 應用場景

客戶的報表伺服器是部署在虛擬機上或者雲平台上的，報表伺服器的物理資訊不固定，這樣就沒有辦法綁定固定的機器資訊，所以本地機器資訊認證不再適用。

這時，需要找一台物理資訊固定的伺服器作為授權伺服器，然後把授權伺服器的機器資訊 rif 檔案發給商務，生成私有雲認證伺服器檔案FanruanLicenseServer，裏面包含一個server.exe檔案。

1.3 功能簡介

報表伺服器物理資訊不固定無法進行本地機器認證時，若有一台物理資訊固定的伺服器，可進行私有雲認證。

授權伺服器（license Server 端）將這個授權的功能點、授權存取域名、授權存取埠、授權存取應用名、授權存取截止日期等資訊傳回給報表伺服器（Report Server 端）。

報表伺服器（Report Server 端）做校驗，如果校驗透過，就進入正常的存取程式，如果不透過，則作為未授權伺服器。如下圖所示：

授權伺服器程式是指的是提供授權功能的那個伺服器程式（需提供物理資訊），報表伺服器是指運作 FineReport 報表的某台伺服器（無需提供物理資訊）。

1.4 注意事項

1）私有雲認證的授權伺服器，需要是一台固定物理資訊的機器。報表工程伺服器所在機器不需要有固定不變的物理資訊。

     例如虛擬機環境下物理資訊可能變化，造成註冊失敗，不適合被用作授權伺服器。

2）報表伺服器即需註冊的報表工程所在伺服器，需要跟授權伺服器網路互通。

3）一個授權伺服器不允許運作兩個私有雲認證程式。

4）認證伺服器卸載後，如需再次採用此機器作為授權伺服器，需重新生成 MachineInfo.rif 檔案傳送給商務重新註冊。

5）在授權個數允許的範圍內，一個授權伺服器可以給多個報表伺服器授權。

6）叢集情況下使用私有雲認證，無需每個節點都傳送註冊資訊到商務。

7）報表伺服器遷移時，不需要重新申請授權檔案。

• 申請授權時，可指定報表伺服器IP範圍，而非指定IP。

• 遷移後，只需保證報表伺服器所在的機器和授權伺服器的網路可以連通，且新報表伺服器IP在申請授權的報表伺服器IP範圍內即可。

8）Linux 情況下支援 i386、arm 和 amd64 位系統 。

9）不支援透過nat存取私有雲。

10）授權伺服器運作的認證程式不可關閉超過 24 小時。

• 若關閉時長小於 24 小時，報表伺服器顯示註冊失敗，在 2 小時內將自動重新連結上授權伺服器，註冊不失效。

• 若關閉時長超過 24 小時，需重新運作認證程式，報表伺服器需要重新進行註冊操作。

11）報表伺服器會每 2 小時向授權伺服器傳送一次請求，授權伺服器收到請求後以後會反饋給報表伺服器。

若連續 12 次（即 24 小時內）收不到反饋，或者授權伺服器連續 24 小時沒有收到請求，則報表伺服器顯示註冊失敗，需重新進行註冊操作。

11.0.18 及之後版本，將在「管理系統>註冊管理」頁面內以列表形式顯示每次認證的失敗時間和失敗原因，幫助使用者排查問題，如下圖所示：注：叢集環境下，每個節點的失敗原因可能不同，將顯示每個節點的失敗原因。

2.1 下載 machine 工具

點選下載 machine 工具，用於獲取授權伺服器資訊檔案：Windows.zip

將壓縮包上傳至授權伺服器，並解壓。

2.2 匯出授權伺服器資訊

以管理者權限運作解壓生成的 machine.exe 檔案，在同目錄下自動生成 require 資料夾。

require 資料夾下的 MachineInfo.rif 檔案，即為匯出的授權伺服器資訊檔案。如下圖所示：

2.3 獲取授權檔案

請使用合同中指定的信箱傳送註冊資訊給 FineReport 商務business@fanruan.com，郵件格式如下： 

商務收到郵件，覈實無誤後會為使用者生成FanruanLicenseServer.zip檔案，以郵件方式傳送給使用者。

注：若有任何特殊情況，請在郵件中註明。

2.4 啟動授權伺服器

在授權伺服器上，解壓商務傳送的授權檔案壓縮包 FanruanLicenseServer.zip。

以管理者權限運作 bin 目錄下的 server.exe 檔案。如下圖所示：

注：若啟動失敗，報錯的原因是埠被佔用，那麼使用命令行啟動程式的時候，後面加參數-port 埠指定另外埠。

       範例：.server.exe -port 8088

注2：2021-10-13 及之後獲取的 server.exe 檔案，支援啟動認證伺服器的時候指定語言，預設簡體中文，額外提供英文。

       啟動命令範例：.server.exe -port 8088 -language en

2.5 設定服務開機自啟動

授權伺服器上的運作的可執行檔案不能關閉，即 Windows下server.exe不能關閉。如果 Server 關掉，重新開啟是未註冊的，需要重新執行 2.4 節操作。

請使用者自行配置\FanruanLicenseServer\bin\server.exe檔案開機自啟動。

注：設定成功後，服務會開機自啟，若需要取代私有雲，需要先把之前的停止。

2.6 報表伺服器驗證授權

報表工程部署在報表伺服器上，管理者登入數據決策系統，點選「管理系統>註冊資訊>版本資訊」，點選「立即註冊」。

認證方式選擇「私有雲認證」，伺服器地址填寫上面授權伺服器顯示的 IP 和監聽埠，例如https://172.16.63.131:8081，點選「提交認證」，如下圖所示：

注1：若提供了授權伺服器域名，則填寫授權伺服器域名，若未提供授權伺服器域名，則填寫 IP 。

注2：請確定報表伺服器可以存取授權伺服器。

認證成功後，如下圖所示：

注1：這裏的最大連結數表示同時能有幾個工程向授權伺服器申請授權註冊。

注2：若認證失敗，檢查防火牆設定，開放對應埠或者關閉防火牆。

3.1 下載 machine 工具

點選下載 machine 工具，用於獲取授權伺服器資訊檔案：

注：一般情況下，64 位的 Linux 用 amd64，32 位的 Linux 用 i386。

      極少情況下（當物理機器使用的是 RISC 精簡指令集，低功耗 CPU）才使用 arm，具體跟使用硬體有關。

3.2 匯出授權伺服器資訊

注：本節操作必須要使用管理者帳號進行，否則會導致啟動授權程式報錯，機器碼不匹配。

以 Linux_amd64 為例：

將壓縮包上傳至授權伺服器，解壓生成 machine.file 檔案：

unzip linux_amd64.zip

為 machine.file 檔案新增權限：

chmod 777 machine

運作 machine.file 檔案，自動生成授權伺服器資訊檔案，即 require 目錄下的 MachineInfo.rif 檔案：

./machine

3.3 獲取授權檔案

請使用合同中指定的信箱傳送註冊資訊給 FineReport 商務business@fanruan.com，郵件格式如下： 

商務收到郵件，覈實無誤後會為使用者生成FanruanLicenseServer.zip檔案，以郵件方式傳送給使用者。

注：若有任何特殊情況，請在郵件中註明。

3.4 啟動授權伺服器

注：如果是工具連結，在使用 nohup ./bin/server &命令行後，使用 exit 跳出登入。

      重新登入後可使用 ps -ef|grep server 命令查看是否運作在後台，若成功運作則表示私有雲後台啟動成功，只要伺服器不關機則會一直運作 。

1）在授權伺服器上，解壓商務傳送的授權檔案壓縮包 FanruanLicenseServer.zip

unzip FanruanLicenseServer.zip

2）解壓完成後，以管理者權限運作 bin 目錄下的 server

nohup ./server &

注：支援啟動認證伺服器的時候指定語言，預設簡體中文，額外提供英文。

       啟動命令範例：./server -language en

3）啟動認證伺服器成功，如下圖所示：

3.5 報表伺服器驗證授權

報表工程部署在報表伺服器上，管理者登入數據決策系統，點選「管理系統>註冊資訊>版本資訊」，點選「立即註冊」。

認證方式選擇「私有雲認證」，伺服器地址填寫上面授權伺服器顯示的 IP 和監聽埠，例如https://172.16.63.131:8081，點選「提交認證」，如下圖所示：

注1：若提供了授權伺服器域名，則填寫授權伺服器域名，若未提供授權伺服器域名，則填寫 IP 。

注2：請確定報表伺服器可以存取授權伺服器。

認證成功後，如下圖所示：

注1：這裏的最大連結數表示同時能有幾個工程向授權伺服器申請授權註冊。

注2：若認證失敗，檢查防火牆設定，開放對應埠或者關閉防火牆。

4.1 下載 machine 工具

點選下載 machine 工具，用於獲取授權伺服器資訊檔案：Mac.zip

4.2 匯出授權伺服器資訊

將壓縮包上傳至授權伺服器，解壓生成 machine.file 檔案：

unzip Mac.zip

為 machine.file 檔案新增權限：

chmod 777 machine

運作 machine.file 檔案，自動生成授權伺服器資訊檔案，即 require 目錄下的 MachineInfo.rif 檔案：

./machine

4.3 獲取授權檔案

請使用合同中指定的信箱傳送註冊資訊給 FineReport 商務business@fanruan.com，郵件格式如下： 

商務收到郵件，覈實無誤後會為使用者生成FanruanLicenseServer.zip檔案，以郵件方式傳送給使用者。

注：若有任何特殊情況，請在郵件中註明。

4.4 啟動授權伺服器

注：授權伺服器上運作的可執行檔案不要關閉，即 Mac 下 server 不能關閉。

在授權伺服器上，解壓商務傳送的授權檔案壓縮包 FanruanLicenseServer.zip。

以管理者權限運作 bin 目錄下的 server ，如下圖所示：

注：支援啟動認證伺服器的時候指定語言，預設簡體中文，額外提供英文。

       啟動命令範例：./server -language en

4.5 報表伺服器驗證授權

報表工程部署在報表伺服器上，管理者登入數據決策系統，點選「管理系統>註冊資訊>版本資訊」，點選「立即註冊」。

認證方式選擇「私有雲認證」，伺服器地址填寫上面授權伺服器顯示的 IP 和監聽埠，例如https://172.16.63.131:8081，點選「提交認證」，如下圖所示：

注1：若提供了授權伺服器域名，則填寫授權伺服器域名，若未提供授權伺服器域名，則填寫 IP 。

注2：請確定報表伺服器可以存取授權伺服器。

認證成功後，如下圖所示：

注1：這裏的最大連結數表示同時能有幾個工程向授權伺服器申請授權註冊。

注2：若認證失敗，檢查防火牆設定，開放對應埠或者關閉防火牆。

11.0.18 之前版本，若註冊失敗，頁面將出現提示彈窗：認證失敗，請重新認證。

11.0.18 及之後版本，註冊失敗提示資訊優化，若註冊失敗，頁面將彈窗提示具體失敗原因，使用者可根據提示資訊進行排查。

5.1 單機環境註冊失敗

若註冊失敗，頁面將彈窗提示具體失敗原因，點選「詳細資訊」按鈕，即可查看具體失敗原因或問題排查方案，如下圖所示：

點選「傳回」回到註冊管理頁面，「註冊資訊」處會顯示註冊失敗和失敗原因，點選「查看錯誤詳情」即可查看具體失敗原因或問題排查方案，如下圖所示：

5.2 叢集環境註冊失敗

若註冊失敗，不同節點的註冊失敗原因可能不同，頁面將彈窗提示每個節點的具體失敗原因，點選「詳細資訊」按鈕，即可查看具體失敗原因或問題排查方案，如下圖所示：

點選「傳回」回到註冊管理頁面，「註冊資訊」處會以列表形式顯示每個節點的失敗原因，點選「查看錯誤詳情」即可查看對應的失敗原因或問題排查方案，如下圖所示：

5.3 失敗原因

註冊失敗原因匯總如下，使用者可根據具體失敗原因或錯誤詳情中提示的排查方案進行排查。

注1：除以下外失敗原因外，其他統一報錯：憑證內容不正確。

注2：一次註冊程式中有多個失敗原因時，僅展示第一次失敗的原因。

6.1 銷燬授權

首先，銷燬當前認證伺服器。以管理者身分進入 bin 目錄，再運作。

6.1.1 Windows

在 Windows 中，開啟 cmd，切換到 bin 目錄下，運作命令如下所示：

.\server.exe -destroy

注：支援卸載認證伺服器的時候指定語言，預設簡體中文，額外提供英文。

       命令範例：./server -destroy -language en

如下圖所示：

6.1.2 Mac 和 Linux

在 Mac 和 Linux中，運作命令如下所示：

./server -destroy

注：支援卸載認證伺服器的時候指定語言，預設簡體中文，額外提供英文。

       命令範例：./server -destroy -language en

如下圖所示：

6.2 獲得銷燬證據檔案

執行銷燬命令後，會銷燬當前的伺服器認證允許，並生成一個銷燬資訊的證據檔案，如下圖所示：

注：在 Windows 中，有時候會報錯，得在與 bin 同級目錄建一個叫 uninstall 的資料夾，卸載檔案會在這個資料夾裏面出現。

6.3 重新註冊

客戶透過郵件傳送給商務下面兩個檔案：

receipt.fr 檔案和按照申請認證伺服器的步驟，重新生成MachineInfo.rif檔案。

商務收到receipt.fr檔案，驗證完成確認銷燬後，再給客戶傳送新的認證伺服器檔案。

注：銷燬授權伺服器後，若重啟報表伺服器則立即註冊失敗；若未重啟報表伺服器則在約 24 小時後註冊失敗。