跳到主要內容

入門指南

本指南將引導您完成讓第一個 Blocklet Server 執行個體啟動並執行的基本步驟。只需幾分鐘，您就能從安裝到擁有一個功能齊全的伺服器。

先決條件

在開始之前，請確保您的系統上已安裝 Node.js。Blocklet Server 需要特定版本的 Node.js 才能正常運作。請參閱專案 package.json 中的 engines 欄位以了解確切的版本要求。

步驟 1：安裝 Blocklet CLI

第一步是使用 npm 全域安裝 Blocklet 命令列介面 (CLI)。此工具提供了管理您的伺服器和 blocklets 所需的所有指令。

開啟您的終端機並執行以下指令：

安裝 Blocklet CLI

bash
npm install -g @blocklet/cli

安裝完成後，您可以透過檢查版本來進行驗證：

驗證安裝

bash
blocklet --version

步驟 2：初始化您的伺服器

CLI 安裝完成後，您需要為您的 Blocklet Server 建立一個設定檔。這可以透過 server init 指令來完成。

  1. 為您的伺服器建立一個新目錄並進入該目錄： 建立伺服器目錄 bash mkdir my-blocklet-server cd my-blocklet-server
  2. 執行初始化指令： 初始化伺服器 bash blocklet server init

此指令將啟動一個互動式設定精靈，引導您完成設定過程。系統將詢問您一些基本資訊，例如伺服器的名稱、描述和連接埠。

互動式設定範例

text
? Naming the server? my-node
? Description of the server? My first Blocklet Server instance
? Which port do you want your server to listen on? 3030
? Choose routing engine (Use arrow keys)
❯ nginx
  caddy
  none
...

完成後，將會建立一個新的 .blocklet-server 目錄，其中包含您的 config.yml 檔案和其他必要的伺服器資料。

步驟 3：啟動伺服器

設定完成後，您現在可以啟動伺服器了。server start 指令會啟動所有必要的背景程序，包括主守護程序和服務。

啟動伺服器

bash
blocklet server start

稍待片刻，伺服器便會開始執行。主控台將顯示您伺服器儀表板的存取網址，您可以使用這些網址透過網頁瀏覽器來管理您的伺服器。

成功啟動輸出

text
...✅ Blocklet Server 守護程序已成功啟動！

ℹ 您的 Blocklet Server 正在以下網址執行：
  - http://192.168.1.100/admin/
  - http://127.0.0.1/admin/

一體化指令

為了更快速地設定，您可以使用 --auto-init 旗標將初始化和啟動合併為一個指令。這非常適合開發或測試環境，因為它會使用預設設定來初始化伺服器並立即啟動它。

自動初始化並啟動

bash
# 確保您在一個空目錄中
blocklet server start --auto-init

此指令將自動使用合理的預設值建立設定，並接著啟動伺服器，待準備就緒後會印出存取網址。

恭喜！您的 Blocklet Server 現已安裝並正在執行。您現在可以前往 伺服器管理 部分，學習如何停止、檢查狀態以及進一步管理您的執行個體。