Upgrading the Agent

On June 14, 2017, we've changed our configuration format from TOML to a much easier to read YAML format

Any agent version 0.2.0-2017.06.20-195307-UTC or later is going to default to the new format.

Here's an example old-style TOML config file:

api_key = "<YOUR_TOKEN_HERE>"

process = "rpm -qa"

path = "/path/to/a/Gemfile.lock"

path = "/path/to/a/composer.lock"

And here's the same configuration in new-style YAML.

api_key: "<YOUR_TOKEN_HERE>"

  - process: "rpm -qa"
  - file: "/path/to/a/Gemfile.lock"
  - file: "/path/to/a/composer.lock"

Besides being easier to edit and understand, this new configuration format was necessary to enable some new features. For more information on how to configure the agent, click here.

What do I need to do?

Luckily, almost nothing. On first boot, the agent will parse your old /etc/appcanary/agent.conf, move it to /etc/appcanary/agent.conf.deprecated, and put a new /etc/appcanary/agent.yml file in its place

You may need to take an additional step depending on how do you do configuration management / deploy the Appcanary agent.

Manually, through the shell

If you're deploying the agent manually, you're good. Just make sure to make any future configuration changes to /etc/appcanary/agent.yml


Make sure that you upgrade the cookbook to at least version 0.4.0


Make sure that you upgrade the module to at least version 0.2.0


Make sure that you upgrade the playbook to at least version 0.2.0

Custom Script

If you're using a custom script, make sure it's using the YAML format described above.


If you have any questions or need any help upgrading or otherwise, please contact us at hello@appcanary.com