blocklet server 指令是管理您的 Blocklet Server 執行個體生命週期和設定的主要工具。它可讓您初始化、啟動、停止和監控伺服器及其上執行的所有 blocklet。對於自行託管 Blocklet Server 的伺服器管理員和開發人員來說,這些指令至關重要。
若要管理個別 blocklet(例如,建立、開發、部署),請參閱 blocklet 指令參考。
用法
Basic Usage
blocklet server <command> [options]全域選項
這些選項可與任何 blocklet server 子指令一起使用。
- -c, --config [node-config]
string— 指定 Blocklet Server 設定檔的路徑。 - -y, --yes
boolean(default:false) — 自動對任何提示回答「是」,適用於腳本編寫。
指令
init
在目前目錄中初始化一個新的 Blocklet Server 設定。此指令會建立必要的檔案和資料夾,包括主要的 config.yml 檔案。
用法
blocklet server init [options]選項
- -f, --force
boolean(default:false) — 初始化 Blocklet Server 執行個體時不詢問任何問題,接受所有預設值。 - -i, --interactive
boolean(default:false) — 以互動模式執行以自訂設定。如果使用--force,則此選項會被忽略。 - --mode
string(default:production) — 設定初始伺服器模式。允許的值為production和debug。 - --https
boolean(default:true) — 為儀表板和 blocklet 啟用預設的 HTTPS 支援。 - --no-https
boolean— 停用預設的 HTTPS 支援。 - --sk
string— 為 Blocklet Server 提供自訂的密鑰。 - --web-wallet-url
string— 指定自訂的網頁錢包 URL。 - --http-port
number(default:80) — 設定服務閘道的 HTTP 連接埠。 - --https-port
number(default:443) — 設定服務閘道的 HTTPS 連接埠。 - --owner-nft-holder
string— 持有所有權 NFT 的帳戶的 DID。 - --owner-nft-issuer
string— 發行所有權 NFT 的帳戶的 DID。 - --trusted-passport-issuer
string— 此節點信任的通行證發行者的 DID。 - --disable-passport-issuance
boolean(default:false) — 停用此節點發行通行證的功能。
start
根據目前目錄中的設定,將 Blocklet Server 作為背景守護程序啟動。
用法
blocklet server start [options]選項
- -u, --update-db
boolean— 使用設定檔中的最新設定更新 Blocklet Server 資料庫。 - --update-blocklet-env
boolean(default:false) — 更新所有已安裝 blocklet 的環境。 - -k, --keep-alive
boolean(default:false) — 伺服器成功啟動後,保持指令執行而不退出。 - -a, --auto-init
boolean(default:false) — 如果設定目錄不存在,則在啟動前自動初始化。 - -m, --force-mode
string— 強制伺服器以指定模式啟動(例如,production、debug、maintenance)。 - --force-intranet
boolean(default:false) — 強制伺服器以內部網路模式執行,忽略任何外部 IP 位址。
stop
平穩地停止執行中的 Blocklet Server 及所有相關的 blocklet 程序。
用法
blocklet server stop [options]選項
- -f, --force
boolean(default:false) — 立即強制停止所有與 Blocklet Server 相關的程序。
status
檢查並顯示 Blocklet Server 的目前狀態,包括其模式、資料目錄以及所有已安裝 blocklet 的狀態。
用法
blocklet server status [options]選項
- --force-intranet
boolean(default:false) — 強制狀態檢查使用內部網路模式,忽略任何外部 IP 位址。
logs
顯示 Blocklet Server 和個別 blocklet 日誌檔案的路徑,以便於存取和偵錯。
用法
blocklet server logsupgrade
將 Blocklet Server CLI 從 npm 註冊表升級到最新的可用版本。
用法
blocklet server upgradeinfo
收集並顯示有助於偵錯和回報問題的環境資訊。這包括作業系統、二進位檔案(Node、npm)、伺服器設定和網路詳細資訊。
用法
blocklet server info [options]選項
- -C, --clipboard
boolean(default:false) — 自動將環境資訊複製到剪貼簿。
cleanup
執行各種伺服器層級的清理任務。
用法
blocklet server cleanup [options]選項
- --target
string(required) — 指定清理目標。可用選項包括:cache、maintenance-status、blacklist、blacklist-expired。
migrate
將 Blocklet Server 資料庫從一個系統遷移到另一個系統。目前支援從 SQLite 遷移到 PostgreSQL。
用法
blocklet server migrate [options]選項
- --dialect
string(required) — 要遷移到的資料庫類型。可用選項為 sqlite 和 postgres。
nginx
將 Nginx 設定為 Blocklet Server 的反向代理。這在生產環境中很有用,Nginx 可以處理 SSL 終止和負載平衡等任務。
用法
blocklet server nginx [options]選項
- --setup
boolean— 為 Blocklet Server 設定 Nginx 環境。這通常需要 sudo 權限。