Which config file to use
A description of the config file format is available here.
Select which config file to use
Butler uses configuration files in YAML format. The config files are stored in the
Prior to Butler v2.1, JSON config files were used. YAML is however much more human readable than JSON, thus the config file was changed to YAML.
JSON config files can still be used though (just create the file in JSON syntax and suffix it with .json), but YAML is the default as of Butler v2.1.
Butler comes with a default config file called
production_template.yaml. Make a copy of it, then rename the copy to
staging.yaml or something else suitable to your specific use case.
Update it as needed (see the config file reference page for details).
Trying to run Butler with the default config file (the one included in the files download from GitHub) will not work - you need to adapt it to your server environment. For example, you need to enter the IP or host name of you Sense server(s), the IP or host name where Butler is running etc.
The name of the config file matters. Butler looks for an environment variable called “NODE_ENV” and then tries to load a config file named with the value found in NODE_ENV.
Butler will look for a config file
Running several Butler instances in parallel
If you have several Sense clusters (for example DEV, TEST and PROD environments) you might probably want several Butler instances.
Solution: Create several config files:
In this scenario three instances of Butler should be started, each given a different config file by setting the NODE_ENV variable as needed when starting Butler.
Note: If running several Butler instances in parallel, you must also ensure that each one uses unique port numbers for their respective REST APIs, UDP servers etc.
Setting environment variables
The method for setting environment variables varies between operating systems:
Mac OS or Linux
If using Docker, the NODE_ENV environment varible is set in the docker-compose.yml file (as already done in the template docker-compose file.)
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.