info

The blocklet server info command is a diagnostic tool designed to collect and display comprehensive environment information. This is particularly useful when you need to report an issue or debug a problem, as it provides a complete snapshot of your Blocklet Server configuration, host system, and relevant software dependencies.

For monitoring the live status of your server and blocklets, see the status command instead.

Usage#

To run the command, execute the following from your terminal:

Options#

Option	Description
--clipboard	Copies the entire output to the system clipboard. This is useful for easily pasting the information into a GitHub issue or support ticket. Note: This may not work on all systems, such as a Linux TTY without a display server.

Information Gathering Process#

The command gathers information in several stages to provide a full picture of your setup.

Information Collected#

The command output is organized into several sections:

Blocklet Server Details#

This section provides details specific to your Blocklet Server instance.

• Server binary from: The path to the blocklet executable.
• Server config from: The path to the config.yml file being used.
• Server router provider: The routing engine in use (e.g., nginx).
• Server http port: The HTTP port the server is listening on.
• Server https port: The HTTPS port the server is listening on.
• Server file system isolation status: Reports whether the file system isolation security feature is active. It can be on(available), on(unavailable, version must be >= 21.6.0) if your Node.js version is too old, or off.
• Docker status: The status of the Docker daemon, if applicable.
• Server domain status: Checks if the DNS to IP mapping for the node's DID is correct or a mismatch.

Host System#

Information about the machine running Blocklet Server.

• Server host cpu: The number of physical cores and total logical CPUs.
• Server host memory: Used and total system memory.
• Server host IP: A list of IP addresses associated with the host.

Environment Details#

Powered by envinfo, this section collects data about the broader development environment.

• System: OS, CPU, and Shell version.
• Binaries: Versions of Node.js, npm, Yarn, pm2, and other relevant tools.
• Browsers: Installed browser versions.
• Servers: Versions of other servers like Apache or Nginx.
• Virtualization: Detected virtualization software like Docker.
• npmPackages: Versions of local @arcblock/* and @abtnode/* packages.
• npmGlobalPackages: Versions of globally installed @arcblock/* and @abtnode/* packages, along with pm2, npm, and yarn.

Example Output#

Now that you know how to use blocklet server info to gather essential diagnostic data, you can more effectively troubleshoot issues. To further investigate, consider inspecting the server's log files with the logs command or checking for available updates with upgrade.