Get Server Info


The blocklet server info command is a vital diagnostic tool designed to collect and display a comprehensive summary of your Blocklet Server's environment. It gathers everything from hardware and OS details to software versions and server configuration, making it invaluable for debugging or providing system information for support.

Usage#

To get the environment summary, run the following command in your server's root directory:

Basic Usage

blocklet server info

Options#

Option

Description

--clipboard

Copies the full environment report to your system's clipboard, making it easy to paste into issue trackers or support channels.

Information Displayed#

The command outputs a detailed report organized into several key areas:

  • Server Configuration: Shows essential settings from your config.yml, including the server's binary path, configuration file location, routing provider, and configured HTTP/HTTPS ports.
  • Host System: Provides details about the host machine's hardware, such as CPU core count, memory usage (used vs. total), and both local and public IP addresses.
  • Live Status Checks: Performs real-time diagnostics on critical components:
    • Domain Status: Verifies if the server's DNS IP mapping correctly corresponds to its DID.
    • File System Isolation: Reports whether this security feature is enabled and available on the host system's Node.js version.
    • Docker Status: Checks if the Docker daemon is installed and running.
  • Software Environment: Leverages the envinfo utility to generate a thorough report on the development environment, including:
    • System: OS, CPU architecture, and default Shell.
    • Binaries: Versions of crucial tools like Node.js, npm, Yarn, and pm2.
    • Virtualization: Detected virtualization software (e.g., Docker).
    • npm Packages: Versions of installed @abtnode/* and @arcblock/* packages in the current project.

Example Output#

Running blocklet server info will produce a report similar to this:

Example Report

ℹ Server binary from: /home/user/.nvm/versions/node/v18.17.1/bin/blocklet
ℹ Server config from: /home/user/my-blocklet-server/.abtnode/abtnode.yml
ℹ Server router provider: ip
ℹ Server http port: 8080
ℹ Server https port: 8443
ℹ Server host cpu: 8 / 16
ℹ Server host memory: 12.5 GiB / 31.2 GiB
ℹ Server host IP: {"local":"192.168.1.101","public":"203.0.113.55"}
ℹ Server file system isolation status: on(available)
ℹ Docker is installed and running
ℹ Server domain status: correct

  System:
    OS: Linux 5.15 Ubuntu 22.04.3 LTS
    CPU: (16) x64 AMD Ryzen 7 5800X
    Shell: 5.1.16 - /bin/bash
  Binaries:
    Node: 18.17.1 - /usr/bin/node
    npm: 9.6.7 - /usr/bin/npm
    Yarn: 1.22.19 - /usr/bin/yarn
    pm2: 5.3.0 - /usr/bin/pm2
  Virtualization:
    Docker: 24.0.5 - /usr/bin/docker
  npmPackages:
    @abtnode/cli: ^1.18.0 => 1.18.0

This command centralizes all necessary diagnostic information, giving you a complete and accurate snapshot of your server's setup for efficient troubleshooting.