PricingDocsAccount

Plugins

What plugins can do, and how to install and manage them.

Plugins

A plugin is a program installed on the host that adds things to the workspace that danio itself doesn't do, such as sending notifications, syncing with other systems or delivering films to a cloud drive.

Plugins run only on the host. Artists' computers and render machines don't install anything and don't run plugins. danio doesn't ship with any plugins for now. Install ones your studio wrote or ones others have published (for how to author a plugin, see Plugin development).

What plugins can do

  • Subscribe to events: when a task is submitted, a chunk finishes or fails, a task needs attention, a film is joined or a new device joins, the plugin is notified and can forward it to places like a Slack or Feishu group.
  • Deliver films: once a film is joined, it is handed to the plugin, which uploads it to a cloud drive or elsewhere. The result shows under Delivery in the task details, and if it failed, you can click Send again.

What a plugin can do to the workspace is limited by the permissions it declares. But it runs on the host with danio's privileges, so it can access the network and read and write files. Only install plugins you trust.

Installing

Plugins are managed under Workspace details → Plugins and integrations. This needs admin access.

  1. Click Add plugin and enter an npm package name, or a folder or .tgz file on the host.
  2. Once it is installed, a confirmation lists the workspace permissions it wants.
  3. Click Enable. If you don't want to use it yet, click Not now.

The first time the host runs a plugin, it downloads Bun automatically, so you don't need to install it. You can also install from the host's terminal with danio plugin add <package name or path>.

Managing

Each plugin has a row showing its version, state, the events it subscribes to, and any required settings that aren't filled in yet.

  • Use the switch on the right to enable it or Disable it. Each time you enable it again, you confirm its permissions again.
  • The menu has Settings…, Log and Delete. Deleting it also deletes its settings and data.
  • Update all reinstalls all plugins from where each came from.

Plugin settings live in the host's database, so plugins keep running after you change hosts.

Further down the same page are integration tokens, for scripts on other computers to call the host's API. See Tokens.