Configuration

Blocklet Server and its command-line interface (CLI) rely on two main types of configuration: the server's primary configuration file for a specific node, and the CLI's client-side settings for developer interaction.

Server Configuration (config.yml)#

Every Blocklet Server instance is defined by a central configuration file, config.yml. This file contains all essential settings, including the server's identity, network configuration, and data storage paths.

File Location#

The CLI automatically finds the config.yml file by looking for a .blocklet-server directory (or a legacy .abtnode directory) in the current working directory and then searching upwards through parent directories. This allows you to run blocklet server commands from anywhere within a project's subdirectories without needing to specify a configuration path.

This diagram illustrates how the CLI locates the configuration file when a command is run from a nested directory:

Core Parameters#

The following are key parameters you can define in your config.yml file:

Key	Description
node.name	The display name for your ABT Node.
node.description	A brief description of your ABT Node.
node.sk	The secret key for the node's wallet.
node.pk	The public key for the node's wallet.
node.did	The Decentralized Identifier (DID) of the node.
node.dataDir	The absolute path where the node's data and blocklets are stored.
node.domain	The domain name or IP address for accessing the node's dashboard.
node.port	The port number for the node's dashboard.
node.https	Set to true to enable HTTPS for the dashboard.
node.secret	A secret string used for dashboard session management.
node.owner.pk	The public key of the node's owner.
node.owner.did	The DID of the node's owner.
blocklet.port	The starting port number for blocklet processes. Each blocklet will use an incremented port.
blocklet.registry	The URL of the blocklet registry where available blocklets are listed.

Example config.yml#

CLI Client Configuration#

The CLI maintains its own configuration for interacting with blocklet stores and identifying you as a developer. These settings are managed with the blocklet config command.

Management Commands#

• blocklet config set <key> <value>: Sets or updates a configuration key.
• blocklet config get <key>: Retrieves the value of a specific configuration key.
• blocklet config list: Displays all currently set CLI configurations.
• blocklet config unset <key>: Deletes a configuration key (aliases: del, delete).

Configurable Keys#

Key	Description
store	The URL of the Blocklet Store for uploading and managing blocklets.
registry	The URL of the Blocklet Registry to fetch blocklets from.
accessToken	The secret key used to authenticate with a Blocklet Store or Server.
developerDid	Your developer DID, used to sign and identify your blocklets.
name	Your developer name, associated with your blocklet submissions.
email	Your developer email address.

Usage Examples#

1. Set your developer info and store URL:

2. View a specific configuration:

3. List all current configurations:

4. Remove a configuration:

Managing Multiple Profiles#

The CLI supports multiple configuration profiles, allowing you to switch between different developer identities or stores easily. Use the --profile option to specify a profile name. If not specified, the default profile is used.

With your server and CLI configured, you are ready to manage your server and develop blocklets. For a detailed list of all commands, see the Command Reference.