Skip to main content

Input

Properties

PropertyTypeRequiredDescriptionDefaultExample
namestringNoinput name Used to reference the input via variable templating (e.g., {{.nuon.inputs.input_name}})-"api_token"
display_namestring✅ Yesdisplay name of the input Human-readable name shown in the installer UI to customers-"API Token"
descriptionstring✅ Yesinput description Detailed explanation of what this input is for, rendered in the installer to guide users-"The API token for authenticating with the external service"
groupstring✅ Yesinput group name Name of the input group this field belongs to. Must match a defined group in the inputs section-"database"
defaultobjectNodefault value for the input Default value used if customer does not provide one. Type must match the input type-"production"
requiredbooleanNowhether input is required If true, customer must provide a value during installation. If false, can be skipped--
sensitivebooleanNowhether input is sensitive If true, the value will be masked/hidden in the UI and logs after the install is created. Use for passwords, tokens, and API keys--
typestringNoinput type Data type for the input. Supported types: string, number, list, json, bool-"string"
internalbooleanNowhether input is internal-only If true, input is only settable via the admin panel and not shown to regular users--
user_configurablebooleanNowhether input is user configurable If true, input can be modified by end users after installation--

Property Details

name

Examples:
"api_token"
"database_url"

display_name

Examples:
"API Token"
"Database URL"

description

Examples:
"The API token for authenticating with the external service"
"Connection string for the PostgreSQL database"

group

Examples:
"database"
"integrations"

default

Examples:
"production"
"5432"

type

Examples:
"string"
"number"
"json"
"bool"