Installing Plugins

Once a plugin has been packaged (see Plugin Packaging) you are ready to install it!

You need access to the server where Karrot is running in order to install plugins.

cd into the directory where Karrot is installed, then run:

python -m karrot.cli plugin install path/to/your/plugin.zip

Restart needed

You will need to restart Karrot in order to fully register the new plugin. This is because dynamic loading in Python/Django is a bit sketchy.

If you are running the gunicorn/uvicorn-based server you can send a SIGHUP to the main process which causes the uvicorn workers to reload, without downtime.

The plugin is unzipped into your PLUGIN_DIR (by default ./plugins/).

You can also run other plugin subcommands:

List installed plugins

python -m karrot.cli plugin list

Which should show you something like this:

 Name            Frontend  Backend
 example-plugin  ✔         ❌

Uninstall plugin

python -m karrot.cli plugin uninstall <plugin-name>