Configuration Reference

The blocklet.yml file is the manifest for your Blocklet. It's a YAML file that defines everything from your project's name and description to its runtime requirements, network interfaces, and dependencies. A correctly configured blocklet.yml is essential for the Blocklet Server to run, manage, and scale your application.

This reference guide is organized by function, providing a comprehensive look at all available configuration fields. Below is a conceptual map of how the configuration is structured.

Below is a summary of each configuration section. Select a section to view the detailed reference for all its properties.

Metadata#

Defines the core identity, descriptive information, and associated links for your Blocklet. This includes properties like name, version, author, and description.

Read the Metadata Reference for details.

Execution#

Configures how your Blocklet's code is executed, including the runtime engine, lifecycle scripts (like pre-start or post-install), and required environments variables.

Read the Execution Reference for details.

Networking#

Specifies how your Blocklet is exposed to the network. This involves defining public interfaces, ports, URL prefixes, and backend services.

Read the Networking Reference for details.

Dependencies#

Declares requirements (like Node.js or OS version) and other Blocklets (components) that this Blocklet depends on to function correctly.

Read the Dependencies Reference for details.

Features#

Enables and configures optional, built-in Blocklet Server capabilities. This includes features like auth for access control, custom navigation menus, event handling, and resource sharing.

Read the Features Reference for details.

Publishing#

Contains information used by a Blocklet Store for discovery and distribution. This section covers payment details for monetization, screenshots for presentation, and dist file information.

Read the Publishing Reference for details.

Now that you have an overview of the configuration structure, a good starting point is to define your Blocklet's core identity. Proceed to the Metadata section to learn more.