Loading vLEI.wiki
Fetching knowledge base...
Fetching knowledge base...
This comprehensive explanation has been generated from 35 GitHub source documents. All source documents are searchable here.
Last updated: October 7, 2025
This content is meant to be consumed by AI agents via MCP. Click here to get the MCP configuration.
Note: In rare cases it may contain LLM hallucinations.
For authoritative documentation, please consult the official GLEIF vLEI trainings and the ToIP Glossary.
Configuration files in KERI are JSON or YAML files that define initialization parameters and operational settings for KERI components such as keystores, AIDs, witnesses, and agents, enabling reproducible and automated setup of KERI infrastructure.
Configuration files in the KERI ecosystem are structured data files (typically JSON or YAML format) that specify the parameters and initial settings for KERI components including keystores, Autonomic Identifiers (AIDs), witness networks, agents, and credential registries. These files enable declarative, reproducible infrastructure setup and are consumed by tools like kli (KERI Command Line Interface) and KERIA (KERI Agent in the cloud).
Configuration files serve as the foundation for KERI infrastructure deployment and testing. They are extensively used throughout the KERI ecosystem:
Keystore Initialization: Files like keystore_init_config.json define witness pools, witness thresholds, and other parameters for creating KERI keystores. Document 2 demonstrates using kli init --config-file keystore_init_config.json to create keystores with pre-configured witness networks.
AID Inception: Configuration files specify the parameters for creating AIDs, including key derivation codes, signing thresholds, witness configurations, and delegation relationships. Document 11 shows aid_inception_config.json being used with kli incept to create transferable AIDs with specific witness configurations.
Witness Configuration: Documents 14 and 32 describe witness configuration files that define witness endpoints, OOBIs, and operational parameters across development, staging, and production environments. The config.yaml file serves as a single source of truth for generating environment-specific witness configurations.
Agent Configuration: Document 28 details KERIA's dual configuration approach supporting both environment variables and JSON configuration files. The JSON structure includes service endpoint URLs (CURLS), introduction URLs (IURLS), data OOBI URLs (DURLS), and timeout settings. Configuration files must include ISO 8601 timestamps for validation.
Configuration files in KERI follow specific structural requirements:
JSON Format Requirements: KERIA configuration files must include ISO 8601 timestamps in dt fields for validation. The root object must match the agent name (default "keria").
File Location: Configuration files are typically specified via command-line parameters like --config-dir and --config-file, allowing flexible deployment across different environments.
Environment-Specific Generation: Document 32 describes using a top-level config.yaml to generate environment-specific configurations for development, staging, and production deployments.
Witness Configuration: Witness pools are specified as arrays of witness AIDs with corresponding OOBI URLs. The toad (threshold of accountable duplicity) parameter defines the minimum number of confirming witnesses required.
Security Considerations: Document 16 explicitly warns against storing sensitive values like salts and private keys in configuration files for production use. Configuration files should reference secure secret management systems rather than containing secrets directly.
Validation: Tools like kli validate configuration files during execution, providing error messages for malformed or incomplete configurations.
Credential Workflows: Document 25 demonstrates configuration files defining complete credential ecosystems including agents, identifiers, credential schemas, and user mappings. These files enable automated testing of credential issuance workflows.
Multi-Signature Setup: Document 14 shows configuration files used during QVI group multisig AID creation, specifying participant roles, witness pools, and threshold requirements.
Configuration files enable infrastructure-as-code practices in KERI deployments, supporting version control, automated testing, and consistent environment setup across development, staging, and production contexts.