index.md

sidebar_position	1
sidebar_label	Overview

Configuration

The VILLASnode configuration consists of a a single file.

For a collection of example configuration files see: https://github.com/VILLASframework/node/tree/master/etc/.

File format

VILLASnode currently supports two config file formats:

• JSON (recommended)
• libconfig

Note: Consider using the villas conf2json command to migrate your old configurations to JSON.

Top-level Structure

At the top level, the configuration file consists of these sections:

• global
• logging
• http
• nodes
• paths

OpenAPI / JSON Schema Specification

There exists a formal description of the configuration file as a JSON Schema / OpenAPI 3.0 specification.

The remaining part of this subsection shows a HTML version of this schema rendered by Redoc:

import ApiSchema from '@theme/ApiSchema';

Example

VILLASnode comes with a lot of existing configurations which can be used for inspiration: https://github.com/VILLASframework/node/tree/master/etc/examples

# Global configuration settings go here
stats = 2

# Webserver / API config
http = {
	port = 8081
}

# Logging
logging = {
	level = "debug
}

# Node definitions
nodes = {
	test_node = {
		in = {
			signals = {
				count = 12
				type = "float"
			}
		}
	}
}

# Path Mapping
paths = (
	{
		in = "test_node",
		out = "test_node"
	}
)