Skip to content

Configuring Plugins

After installing a plugin, you need to configure its credentials before it can be used.

Setting Up Credentials

  1. Go to Settings → Plugins
  2. Find your plugin and click Configure
  3. Fill in the required fields:
    • Password fields (API keys, tokens, secrets) are encrypted and stored securely
    • Text fields (base URLs, project IDs) are stored as plain settings
  4. Click Save or Save & Test

Field Types

The configuration form is generated from the plugin's manifest:

TypeInputStorage
stringText inputPlain settings (JSON)
passwordPassword input (masked)Encrypted credentials
integerNumber inputPlain settings
booleanToggle selectPlain settings

Masked Credentials

Once saved, credential values are never shown in full. You'll see masked indicators like:

  • sk-****1234
  • to-****abcd

To update a credential, enter the new value in the Configure modal. Leave masked values unchanged to keep existing credentials.

Testing Connections

After configuring, click the Test button (wifi icon) on the plugin card. The test:

  1. Finds a read-only (GET) capability or one named "test" / "health"
  2. Executes it with empty parameters
  3. Shows success (with duration) or the error message

Troubleshooting

IssueSolution
"Plugin not configured"Open Configure and fill in required fields
Connection test failsVerify your API key or token is correct
"Request timed out"The external API may be slow or unreachable (30s timeout)
Credential decryption errorThe server secret may have changed — reconfigure credentials

Built by HelixNode