跳到主要内容

快速入门

本指南将引导您完成让第一个 Blocklet Server 实例启动并运行的基本步骤。只需几分钟,您就可以从安装到拥有一个功能齐全的服务器。

先决条件

在开始之前,请确保您的系统上已安装 Node.js。Blocklet Server 需要特定版本的 Node.js 才能正常运行。有关确切的版本要求,请参阅项目中 package.json 文件的 engines 字段。

第 1 步:安装 Blocklet CLI

第一步是使用 npm 全局安装 Blocklet 命令行界面 (CLI)。该工具提供了管理您的服务器和 blocklets 所需的所有命令。

打开您的终端并运行以下命令:

Install Blocklet CLI

bash
npm install -g @blocklet/cli

安装完成后,您可以通过检查版本来验证:

Verify Installation

bash
blocklet --version

第 2 步:初始化您的服务器

现在 CLI 已安装,您需要为您的 Blocklet Server 创建一个配置。这可以通过 server init 命令完成。

  1. 为您的服务器创建一个新目录并进入该目录: Create Server Directory bash mkdir my-blocklet-server cd my-blocklet-server
  2. 运行初始化命令: Initialize Server bash blocklet server init

此命令将启动一个交互式设置向导,引导您完成配置过程。您将被要求提供基本信息,例如服务器的名称、描述和端口。

Interactive Setup Example

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 命令会启动所有必要的后台进程,包括主守护进程和服务。

Start the Server

bash
blocklet server start

稍等片刻,服务器就会运行起来。控制台将显示您的服务器仪表盘的访问 URL,您可以使用它通过 Web 浏览器管理您的服务器。

Successful Start Output

text
...✅ Blocklet Server daemon started successfully!

ℹ Your Blocklet Server is running at the following URLs:
  - http://192.168.1.100/admin/
  - http://127.0.0.1/admin/

一体化命令

为了更快地设置,您可以使用 --auto-init 标志将初始化和启动合并为一个命令。这非常适合开发或测试环境,因为它会使用默认设置初始化服务器并立即启动它。

Auto-Initialize and Start

bash
# 确保您在一个空目录中
blocklet server start --auto-init

此命令将自动使用合理的默认值创建配置,并继续启动服务器,在准备就绪后打印出访问 URL。

恭喜!您的 Blocklet Server 现已安装并正在运行。您现在可以继续阅读 服务器管理 部分,学习如何停止、检查状态以及进一步管理您的实例。