Skip to main content

Let installers customize a module

Every module your app uses (a database connection, a RAG index, an MCP server, a channel...) ships with the config values you gave it in your app's own configuration. By default, that's the whole story: installers get exactly what you configured, and nothing about that module shows up in their own app settings at all.

Sometimes that's not what you want. Maybe your app's RAG module should point at a folder the installer picks themselves, or your database module should use their own connection instead of yours. For those cases, you can open up a specific module for the installer to see and change - without opening up the others.

The default: invisible, not just locked​

Unless you say otherwise, a module's settings never appear as a tab in an installer's app settings. This isn't the same as showing a greyed-out, disabled panel - there's simply nothing there. As far as the installer's app settings are concerned, that module doesn't have anything to configure.

This is deliberate: most modules exist to make your app work a specific way, and most installers should never need to think about them.

Turning it on for one module​

In Studio, open the module's node and look for "Let installers customize this" in its Install section. It's off by default. Switch it on, and from the next publish or redeploy onward, that module gets its own tab in every installer's app settings, where they can see and edit its config - the values you set stay as the starting point, and the installer's own changes are theirs alone, per install.

This is a per-module choice. Turning it on for your RAG module doesn't touch your database module, your MCP servers, or anything else - each one keeps its own switch.

What this doesn't change​

Whether a module's settings tab is editable at all is a separate question from whether it's currently usable. An installer whose app isn't running in BYOK mode still sees a locked, greyed-out form inside a tab you've opened up for them - the same behavior as before, just now something they can see is there rather than a tab that's missing entirely. Turning a module's tab on and enabling BYOK are two different switches for two different concerns.

Going further​