Configuring MudPi

MudPi loads everything it needs from a JSON formatted file in the root installation folder named mudpi.config. This file can be manually created or you can use our free configuration tool to create your file to make your life easier.

Here is the barebone structure of the configuration file. MudPi will only load components and services found in this configuration file on boot. There should not be empty or null values in this config file. Instead the option should be omitted if it is not used.

{
    "name": "MudPi",
    "debug": false,
    "camera": {},
    "redis": {},
    "relays": [],
    "workers": [],
    "nodes": []
}

You can see there are several sections to the configuration file. Currently name, version, debug, and redis are the only required options.

MudPi includes an example configuration file to get you started. You can find this file in the installation root named mudpi.config.example.

General Settings

OptionTypeRequiredDescription
name[String]YesName of the system. Mainly here for labeling the system and to pull for a UI.
debug[Boolean]YesIf enabled, MudPi will output more information while the system runs. More information about the startup sequence and each of the cycles will be output.

Basic Test Configuration

Try booting with only the required options in order to see if all the dependencies have been installed and if MudPi will successfully run. Below is an example of the minimum configuration options needed to test the system.

{
    "name": "MudPi",
    "debug": false,
    "redis": {
        "host": "127.0.0.1",
        "port": 6379
    }
}

Troubleshooting

If your having trouble getting your configuration file to load make sure to look closely at your value types (i.e. "10" is not the same as 10). Make sure there are no empty settings values, option settings should be removed rather than left empty/null. Check all your quotes, colons, commas, brackets, parenthesis and capitalization.