Check Status

The blocklet server status command is a vital tool for monitoring the health of your Blocklet Server instance and all the blocklets running within it. It provides a quick, comprehensive snapshot of your entire system, from the core server process to individual blocklet states.

Usage#

To check the status, run the following command in your terminal. It's typically run from within the Blocklet Server's data directory, but it can be run from any directory as it locates the running server process.

blocklet server status

blocklet server status

Example Output#

A typical output will look like this, providing detailed information about the server and installed blocklets:

Output

Blocklet Server status: Running (2 hours 15 minutes)
Blocklet Server mode: Production
Blocklet Server Data Directory: /home/user/.blocklet-server
Blocklet Server Router Engine: @blocklet/router-nginx
Blocklet Server Database: @blocklet/db-sqlite

Blocklets Status:
┌──────────────────────────────┬───────────────┬────────────────────────────────────────────────────────────────────┐
│ Name                         │ Status        │ URL                                                                │
├──────────────────────────────┼───────────────┼────────────────────────────────────────────────────────────────────┤
│ My Awesome App               │ running       │ https://z2qa7g7b1f6d8e...did.abtnet.io                              │
├──────────────────────────────┼───────────────┼────────────────────────────────────────────────────────────────────┤
│ Data Analytics Tool          │ stopped       │ https://z8t9b3c2d1e0f...did.abtnet.io                              │
├──────────────────────────────┼───────────────┼────────────────────────────────────────────────────────────────────┤
│ Internal Dashboard           │ errored       │ https://z5m4n3o2p1q0r...did.abtnet.io                              │
└──────────────────────────────┴───────────────┴────────────────────────────────────────────────────────────────────┘

You can access your blocklet server with either of the following URLs:
- http://192.168.1.100
- http://localhost

Understanding the Output#

Server Information#

This section gives you an overview of the core server process:

  • Blocklet Server status: Shows the current state of the server daemon. Common statuses include Running, Stopped, Starting, Stopping, and Errored. If running, it also displays the uptime.
  • Blocklet Server mode: Indicates if the server is running in Production or Development mode.
  • Blocklet Server Data Directory: The absolute path to the server's data directory where configuration, blocklets, and data are stored.
  • Router Engine & Database: Displays the currently configured providers for routing (e.g., nginx) and the database (e.g., sqlite).

Blocklets Status#

This table lists all blocklets installed on the server:

  • Name: The human-readable title of the blocklet, as defined in its blocklet.yml.
  • Status: The current runtime state of the individual blocklet (e.g., running, stopped, errored).
  • URL: The unique, decentralized URL to access the blocklet's web interface.

Access URLs#

When the server is running, this section provides the local network and/or localhost URLs to access the Blocklet Server's main dashboard in your web browser.

Options#

--force-intranet
boolean
By default, the command may show public URLs if available. Use this flag to ensure that only local network (intranet) IP addresses are displayed in the 'Access URLs' section. This is useful when you are on a local network and want to ensure you are connecting directly.

blocklet server status --force-intranet

Special Cases#

  • If the server is not started, the command will simply output:
    Blocklet Server is not started
  • If no blocklets are installed, you will see a warning message instead of a table:
    No blocklets installed yet.

After checking the status, you might want to inspect the server logs for more detailed information or manage the server state.

Stop Server
View Logs