NocoBase CRM Demo 部署指南
原文鏈接:https://www.nocobase.com/cn/tutorials/nocobase-crm-demo-deployment-guide
為了讓您能夠快速、順暢地將此 Demo 部署到您自己的 NocoBase 環(huán)境中,我們提供了兩種還原方式。請根據(jù)您的用戶版本和技術(shù)背景選擇最適合您的一種。
在開始之前,請確保
- 您已經(jīng)有了一個基礎(chǔ)的 NocoBase 運行環(huán)境。關(guān)于主系統(tǒng)的安裝,請參考更詳細的官方安裝文檔。
- 您已經(jīng)下載了我們 CRM Demo 的相應(yīng)文件:
- 備份文件(約21.2MB):crm_demo_20250711.nbdata - 適用于方法一
- SQL文件(壓縮后約9MB):crm_demo_20250711_sql.zip - 適用于方法二
重要說明:本 Demo 基于 PostgreSQL 數(shù)據(jù)庫制作,請確保您的環(huán)境使用 PostgreSQL 數(shù)據(jù)庫。
方法一:使用備份管理器還原(推薦專業(yè)/企業(yè)版用戶)
這種方式通過 NocoBase 內(nèi)置的“備份管理器”(專業(yè)/企業(yè)版)插件進行一鍵還原,操作最簡單。但它對環(huán)境和用戶版本有一定要求。
核心特點
- 優(yōu)點:
- 操作便捷:在 UI 界面即可完成,可以完整地還原包括插件在內(nèi)的所有配置。
- 完整還原:能夠還原所有系統(tǒng)文件,包括模板打印文件、表中文件字段上傳的文件等,確保 Demo 功能完整性。
- 局限:
- 專業(yè)/企業(yè)版限定:“備份管理器”是企業(yè)級插件,僅專業(yè)/企業(yè)版用戶可用。
- 環(huán)境要求嚴格:要求您的數(shù)據(jù)庫環(huán)境(版本、大小寫敏感設(shè)置等)與我們制作備份時的環(huán)境高度兼容。
- 插件依賴:如果 Demo 中包含了您本地環(huán)境中沒有的商業(yè)插件,還原會失敗。
操作步驟
第 1 步:【強烈建議】使用 full 鏡像啟動應(yīng)用
為了避免因缺少數(shù)據(jù)庫客戶端而導(dǎo)致的還原失敗,我們強烈建議您使用 full 版本的 Docker 鏡像。它內(nèi)置了所有必需的配套程序,讓您無需進行額外配置。
拉取鏡像的指令示例:
docker pull nocobase/nocobase:1.8.1-full
然后使用此鏡像啟動您的 NocoBase 服務(wù)。
注:若不使用
full鏡像,您可能需要在容器內(nèi)手動安裝pg_dump數(shù)據(jù)庫客戶端,過程繁瑣且不穩(wěn)定。
第 2 步:開啟“備份管理器”插件
- 登錄您的 NocoBase 系統(tǒng)。
- 進入
插件管理。 - 找到并啟用
備份管理器插件。

第 3 步:從本地備份文件還原
- 啟用插件后,刷新頁面。
- 進入左側(cè)菜單的
系統(tǒng)管理->備份管理器。 - 點擊右上角的
從本地備份還原按鈕。
![20250711014216]()
- 將我們提供給您的 Demo 備份文件(通常是
.zip格式)拖拽到上傳區(qū)域。 - 點擊
提交,耐心等待系統(tǒng)完成還原即可,這個過程可能需要幾十秒到幾分鐘不等。
![20250711014250]()
?? 注意事項
- 數(shù)據(jù)庫兼容性:這是此方法最關(guān)鍵的一點。您的 PostgreSQL 數(shù)據(jù)庫版本、字符集、大小寫敏感設(shè)置必須與 Demo 備份源文件匹配。特別是
schema名稱必須一致。 - 商業(yè)插件匹配:請確保您已擁有并開啟了 Demo 所需的所有商業(yè)插件,否則還原會中斷。
方法二:直接導(dǎo)入 SQL 文件(通用,更適合社區(qū)版)
這種方式通過直接操作數(shù)據(jù)庫來還原數(shù)據(jù),繞過了“備份管理器”插件,因此沒有專業(yè)/企業(yè)版插件的限制。
核心特點
- 優(yōu)點:
- 無版本限制:適用于所有 NocoBase 用戶,包括社區(qū)版。
- 高兼容性:不依賴應(yīng)用內(nèi)的
dump工具,只要能連接數(shù)據(jù)庫即可操作。 - 高容錯性:如果 Demo 包含您沒有的商業(yè)插件(如 ECharts 圖表),相關(guān)功能將不會被啟用,但不會影響其他功能的正常使用,應(yīng)用可成功啟動。
- 局限:
- 需要數(shù)據(jù)庫操作能力:需要用戶具備基礎(chǔ)的數(shù)據(jù)庫操作能力,例如如何執(zhí)行一個
.sql文件。 - ?? 系統(tǒng)文件丟失:此方法會丟失所有系統(tǒng)文件,包括模板打印文件、表中文件字段上傳的文件等。這意味著:
- 打印模板功能可能無法正常使用
- 已上傳的圖片、文檔等文件將丟失
- 涉及文件字段的功能將受到影響
- 需要數(shù)據(jù)庫操作能力:需要用戶具備基礎(chǔ)的數(shù)據(jù)庫操作能力,例如如何執(zhí)行一個
操作步驟
第 1 步:準(zhǔn)備一個干凈的數(shù)據(jù)庫
為您即將導(dǎo)入的 Demo 數(shù)據(jù)準(zhǔn)備一個全新的、空的數(shù)據(jù)庫。
第 2 步:將 .sql 文件導(dǎo)入數(shù)據(jù)庫
獲取我們提供的 Demo 數(shù)據(jù)庫文件(通常是 .sql 格式),并將其內(nèi)容導(dǎo)入到您上一步準(zhǔn)備好的數(shù)據(jù)庫中。執(zhí)行方式有多種,取決于您的環(huán)境:
-
選項 A:通過服務(wù)器命令行(以 Docker 為例)
如果您使用 Docker 安裝 NocoBase 和數(shù)據(jù)庫,可以將.sql文件上傳到服務(wù)器,然后使用docker exec命令來執(zhí)行導(dǎo)入。假設(shè)您的 PostgreSQL 容器名為my-nocobase-db,文件名為crm_demo.sql:# 將 sql 文件復(fù)制到容器內(nèi) docker cp crm_demo.sql my-nocobase-db:/tmp/ # 進入容器執(zhí)行導(dǎo)入指令 docker exec -it my-nocobase-db psql -U your_username -d your_database_name -f /tmp/crm_demo.sql -
選項 B:通過遠程數(shù)據(jù)庫客戶端
如果您的數(shù)據(jù)庫暴露了端口,可以使用任何圖形化數(shù)據(jù)庫客戶端(如 DBeaver, Navicat, pgAdmin 等)連接到數(shù)據(jù)庫,新建一個查詢窗口,將.sql文件的全部內(nèi)容粘貼進去,然后執(zhí)行即可。
第 3 步:連接數(shù)據(jù)庫并啟動應(yīng)用
配置您的 NocoBase 啟動參數(shù)(如環(huán)境變量 DB_HOST, DB_PORT, DB_DATABASE, DB_USER, DB_PASSWORD 等),使其指向您剛剛導(dǎo)入了數(shù)據(jù)的數(shù)據(jù)庫。然后,正常啟動 NocoBase 服務(wù)。

?? 注意事項
- 數(shù)據(jù)庫權(quán)限:此方法要求您擁有可以直接操作數(shù)據(jù)庫的賬號和密碼。
- 插件狀態(tài):導(dǎo)入成功后,系統(tǒng)中包含的商業(yè)插件數(shù)據(jù)雖然存在,但如果您本地未安裝并啟用對應(yīng)插件,相關(guān)功能(如Echarts圖表、特定字段等)將無法顯示和使用,但這不會導(dǎo)致應(yīng)用崩潰。
總結(jié)與對比
| 特性 | 方法一:備份管理器 | 方法二:直接導(dǎo)入 SQL |
|---|---|---|
| 適用用戶 | 專業(yè)/企業(yè)版用戶 | 所有用戶(包括社區(qū)版) |
| 操作簡易度 | ????? (非常簡單,UI 操作) | ??? (需要基礎(chǔ)數(shù)據(jù)庫知識) |
| 環(huán)境要求 | 嚴格,數(shù)據(jù)庫、系統(tǒng)版本等需高度兼容 | 一般,需要數(shù)據(jù)庫兼容 |
| 插件依賴 | 強依賴,還原時會校驗插件,缺少任何插件都會導(dǎo)致還原失敗。 | 功能強依賴于插件。數(shù)據(jù)可獨立導(dǎo)入,系統(tǒng)具備基礎(chǔ)功能。但若缺少對應(yīng)插件,相關(guān)功能將徹底無法使用。 |
| 系統(tǒng)文件 | ? 完整保留(打印模板、上傳文件等) | ? 會丟失(打印模板、上傳文件等) |
| 推薦場景 | 企業(yè)用戶,且環(huán)境可控、一致,需要完整功能演示 | 缺少部分插件,追求高兼容、靈活性,非專業(yè)/企業(yè)版用戶,可接受文件功能缺失 |
希望本教程能幫助您順利部署 CRM Demo。如果您在操作過程中遇到任何問題,歡迎隨時與我們聯(lián)系!

了解如何將 NocoBase CRM Demo 部署到您的環(huán)境中。本指南提供兩種部署方式:備份管理器(專業(yè)/企業(yè)版)和通用 SQL 導(dǎo)入(適用于社區(qū)版)。根據(jù)您的版本和需求選擇最適合的方法,快速體驗完整的 CRM 功能演示。


浙公網(wǎng)安備 33010602011771號