The general.json is the central configuration object of LoxBerry beginning with LoxBerry 2.2. In all versions before LoxBerry 2.2, the general.cfg (ini-style config file) was the primary configuration object of LoxBerry (and is automatically generated also by LoxBerry 2.2+).

The general.json includes all the configuration done in the widgets, including the Miniservers and it's network settings and credentials. For Perl and PHP users, it is recommended to use the library functions from LoxBerry::System (Perl) and loxberry_system.php (PHP), as they provide on-the-fly calculated information like your plugin directory and resolved network settings of the Miniservers. With other languages, like Python or Node.js, read the general.json.

The general.json (and general.cfg too) by design is thought to be read-only for plugin developers. Reading of the file is allowed, changes are forbidden.

This is a mapping table of all general.json settings and general.cfg settings. Not all settings of general.json are present in general.cfg (and vice versa) because of new features. Key names in general.json are always first-letter-uppercase (e.g. Base.Sendstatistic, or Ipv4address), in general.cfg everything is capital letters (e.g. BASE.SENDSTATISTIC). Key names are not equal in all cases. Note, that LoxBerry::System/loxberry_system.php functions like get_miniservers use other casing for the values.

general.json introduced hierarchy of objects, that were not possible in the ini format. The general.json - like general.cfg - still maintains main sections as objects,, e.g. Base, Miniserver, Network.

This examples show, how to access the above listed properties

• Webserver.Port, and
• Miniserver.1.Name

• Use decode_json to parse the content to a $cfg variable
• To access Webserver.Port: $cfg->{Webserver}→{Port}
• To access the Miniserver.x.Name of the first Miniserver: $cfg->{Miniserver}->{1}->{Name}

• Use json_decode to parse the content to a $cfg object (without the assoc = true parameter, so the content is parsed to be objects
• To access Webserver.Port: $cfg->Webserver->Port
• To access the Miniserver.x.Name of the first Miniserver: $cfg->Miniserver->{1}->Name

• Use JSON.Parse to parse the content to a cfg object
• To access Webserver.Port: cfg.Webserver.Port
• To access the Miniserver.x.Name of the first Miniserver: cfg.Miniserver[1].Name

• Use import json and  cfg = json.loads to parse the content to a cfg object
• To access Webserver.Port: cfg['Webserver']['Port']
• To access the Miniserver.x.Name of the first Miniserver: cfg['Miniserver']['1']['Name']

Use the pre-installed tool jq to assign the result of every needed line to a variable:

• To access Webserver.Port: PORT=$(jq -r '.Webserver.Port' "$LBSCONFIG/general.json")
• To access the Miniserver.x.Name of the first Miniserver: MSNAME=$(jq -r '.Miniserver["1"].Name' "$LBSCONFIG/general.json")
• Use the variables, e.g. echo $MSNAME $PORT

Perl Modul LoxBerry::System::General