Skip to main content

TemplateInput

namestringrequired
kindstringrequired

Possible values: [path, port, string, secret, timezone, device]

rolestring

Possible values: [appdata, share, media, downloads, gpu]

labelstring
descriptionstring
valuestring

What the input resolves to. Absent for a secret, whose value is only ever written to the stack's .env; empty for a device input with no GPU chosen.

requestedValuestring

Present on a port input whose requested port is taken: the port asked for, while value is the next free port instead.

generatedbooleanrequired

A secret that the install generates.

requiredbooleanrequired

True for an input that may not be left empty: a path, a port, or a string input the template does not mark optional.

errorstring

Present on a required input that has no value and no default: what is missing. previewTemplateInstall lists the input with this instead of refusing the request, so a form can show every field; installTemplate refuses the same input with 400 invalid_template_input.

suggestionsstring[]

The existing shares' paths for a path input that is not appdata; the host's /dev/dri render devices for a device input.

TemplateInput
{
"name": "string",
"kind": "path",
"role": "appdata",
"label": "string",
"description": "string",
"value": "string",
"requestedValue": "string",
"generated": true,
"required": true,
"error": "string",
"suggestions": [
"string"
]
}