Installing plugins and management commands

Plugins and management commands are managed outside of the Canopy installation paths - mostly as these need to survive upgrades, and can also contain code written by our users (see Writing plugins).

Installing plugins

Plugins (Python files) must be copied to the following plugin path and must be readable by the canopy user: /var/opt/checksec/canopy/plugins

Remember to restart Canopy services afterwards.

Installing management commands

Management commands (Python files) must be copied to the following management command path and must be readable by the canopy user: /var/opt/checksec/canopy/commands

Remember to restart Canopy services afterwards.

Removing old plugins / management commands

If you need to remove or replace a plugin or management command, you can simply delete the associated .py and .pyc file from the target directory.

Remember to restart Canopy services afterwards.

Verifying permissions

All files under /var/opt/checksec/canopy needs to be owned by the canopy user:

chown -R canopy: /var/opt/checksec/canopy

Once you’re done, restart

Once the plugins or management code has been installed or removed, restart the services:

sudo systemctl restart canopy canopy-celery

You can check that the plugin has been loaded by looking at the log data (journal file):

sudo journalctl -u canopy -u canopy-celery --since today

The log file will contain information about the plugin loading, which includes the version tag.