Fablo Configuration File Reference

Table of Contents

1. Overview
2. $schema — schema URL for the config
3. global — network-wide settings (Fabric version, TLS, images, engine, monitoring, tools)
4. orgs — organization definitions (CA, orderers, peers, tools)
5. channels — channel definitions and organization/peer membership
6. chaincodes — chaincode definitions, endorsement, and private data collections
7. hooks — commands run after generate / start

Overview

A Fablo configuration file is a JSON or YAML document. Required top-level sections: global, orgs, channels, and chaincodes. Optional top-level fields: $schema and hooks.

This page covers the main fields used in practice. For the full JSON Schema (including schema-only defaults), see schema.json. Note that some schema defaults (for example Fabric 2.4.2 or a solo orderer) are stale relative to what fablo init generates today — prefer the fablo init defaults below when starting a new network.

What fablo init generates today: Fabric 3.1.0, TLS on, two BFT orderers, two LevelDB peers under Org1, channel my-channel1, empty chaincodes and hooks.

$schema

fablo init sets this to the schema for the current Fablo release, for example:

"$schema": "https://github.com/hyperledger-labs/fablo/releases/download/<version>/schema.json"

global

Basic settings of the Hyperledger Fabric network. Type: object. Required fields: fabricVersion, tls.

global.fabricImages

Optional Docker images for Hyperledger Fabric components.

global.monitoring

Optional settings for monitoring purposes.

global.tools

Explorer is supported on Fabric v2 only, not on Fabric v3 (including the default 3.1.0 init config). See SUPPORTED_FEATURES.md.

Example

"global": {
  "fabricVersion": "3.1.0",
  "tls": true,
  "peerDevMode": false
}

orgs

An array of organization definitions. Type: array. Each item’s required field: organization.

orgs[].organization

Basic information about the organization. Required fields: name, domain.

orgs[].ca

Organization Certificate Authority (CA) settings.

orgs[].orderers

An array of orderer group definitions for this organization. Each item requires groupName, type, instances. Organizations without orderers omit this field or use an empty array.

Notes:

• solo is for Fabric v2 development only; it is not supported on Fabric v3.
• BFT requires Fabric v3.
• fablo init creates one orderer group: groupName: "group1", type: "BFT", instances: 2.

orgs[].peer

Peer settings for this organization. If a peer object is present, instances is required within it. Orderer-only organizations (such as orgs[0] from fablo init) typically have no peer block.

orgs[].tools

Fablo REST is a separate REST API client for CA and chaincodes. It is not the same as the optional Node.js gateway sample copied by fablo init gateway. Explorer is Fabric v2 only.

Example

"orgs": [
  {
    "organization": {
      "name": "Orderer",
      "mspName": "OrdererMSP",
      "domain": "orderer.example.com"
    },
    "ca": { "prefix": "ca", "db": "sqlite" },
    "orderers": [
      { "groupName": "group1", "prefix": "orderer", "type": "BFT", "instances": 2 }
    ]
  },
  {
    "organization": {
      "name": "Org1",
      "mspName": "Org1MSP",
      "domain": "org1.example.com"
    },
    "ca": { "prefix": "ca", "db": "sqlite" },
    "orderers": [],
    "peer": { "prefix": "peer", "instances": 2, "db": "LevelDb" }
  }
]

channels

An array of channel definitions. Type: array. Each item’s required fields: name, orgs.

ordererGroup references an orderer group’s groupName, not an organization name.

channels[].orgs[]

Each item requires name and peers.

Example

"channels": [
  {
    "name": "my-channel1",
    "ordererGroup": "group1",
    "orgs": [
      { "name": "Org1", "peers": ["peer0", "peer1"] }
    ]
  }
]

chaincodes

An array of chaincode definitions. Type: array. Each item’s required fields: name, version, lang, channel. Additionally, if lang is ccaas, image is required; otherwise directory is required.

Constraints:

• chaincodeMountPath and chaincodeStartCommand are only valid when lang is ccaas. Using them with node / golang / java fails validation.
• fablo init ccaas cannot be combined with node or dev.
• Peer dev mode (global.peerDevMode / fablo init node dev) has Fabric-version limits; see SUPPORTED_FEATURES.md.

chaincodes[].privateData[]

Each item requires name and orgNames.

Example

"chaincodes": [
  {
    "name": "chaincode1",
    "version": "0.0.1",
    "lang": "node",
    "channel": "my-channel1",
    "endorsement": "AND ('Org1MSP.member')",
    "directory": "./chaincodes/chaincode-kv-node",
    "privateData": [
      { "name": "privateCollectionOrg1", "orgNames": ["Org1"] }
    ]
  }
]

CCaaS example:

{
  "name": "chaincode1",
  "version": "0.0.1",
  "lang": "ccaas",
  "channel": "my-channel1",
  "image": "ghcr.io/fablo-io/fablo-sample-kv-node-chaincode:2.2.0",
  "chaincodeStartCommand": "npm run start:ccaas"
}

hooks

Optional Bash commands run after specific events.

Example

"hooks": {
  "postGenerate": "npm i --prefix ./chaincodes/chaincode-kv-node",
  "postStart": "echo network is up"
}