跳到主要内容

blocklet server

blocklet server 命令是管理 Blocklet Server 实例生命周期和配置的主要工具。它允许您初始化、启动、停止和监控服务器及其上运行的所有 blocklet。这些命令对于自行托管 Blocklet Server 的服务器管理员和开发人员至关重要。

有关管理单个 blocklet（例如，创建、开发、部署）的信息，请参阅 blocklet 命令参考。

用法

Basic Usage

bash
blocklet server <command> [options]

全局选项

这些选项可用于任何 blocklet server 子命令。

  • -c, --config [node-config] string — 指定 Blocklet Server 配置文件的路径。
  • -y, --yes boolean (default: false) — 自动对任何提示回答“是”，这对于脚本编写非常有用。

命令

init

在当前目录中初始化一个新的 Blocklet Server 配置。此命令会创建必要的文件和文件夹，包括主配置文件 config.yml。

用法

bash
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 作为后台守护进程启动。

用法

bash
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 进程。

用法

bash
blocklet server stop [options]

选项

  • -f, --force boolean (default: false) — 立即强制停止所有与 Blocklet Server 相关的进程。

status

检查并显示 Blocklet Server 的当前状态，包括其模式、数据目录以及所有已安装 blocklet 的状态。

用法

bash
blocklet server status [options]

选项

  • --force-intranet boolean (default: false) — 强制状态检查使用内网模式，忽略任何外部 IP 地址。

logs

显示 Blocklet Server 和单个 blocklet 日志文件的文件路径，以便于访问和调试。

用法

bash
blocklet server logs

upgrade

将 Blocklet Server CLI 从 npm 注册表升级到最新的可用版本。

用法

bash
blocklet server upgrade

info

收集并显示有助于调试和报告问题的环境信息。这包括操作系统、二进制文件（Node、npm）、服务器配置和网络详细信息。

用法

bash
blocklet server info [options]

选项

  • -C, --clipboard boolean (default: false) — 自动将环境信息复制到剪贴板。

cleanup

执行各种服务器级别的清理任务。

用法

bash
blocklet server cleanup [options]

选项

  • --target string (required) — 指定清理目标。可用选项包括：cache、maintenance-status、blacklist、blacklist-expired。

migrate

将 Blocklet Server 数据库从一个系统迁移到另一个系统。目前支持从 SQLite 迁移到 PostgreSQL。

用法

bash
blocklet server migrate [options]

选项

  • --dialect string (required) — 要迁移到的数据库方言。可用选项为 sqlite 和 postgres。

nginx

将 Nginx 配置为 Blocklet Server 的反向代理。这对于 Nginx 可以处理 SSL 终止和负载均衡等任务的生产环境非常有用。

用法

bash
blocklet server nginx [options]

选项

  • --setup boolean — 为 Blocklet Server 设置 Nginx 环境。这通常需要 sudo 权限。