UnraidConversion
The template XML as it was sent, to show beside compose.
The generated Compose file. Not applied anywhere: a service named after the template and, where the template needs them, the top-level networks and volumes it refers to.
True when the Compose file needs no manual action: no warning of class untranslated_flag, untranslated_field, flagged_path, missing_network or conflict.
warnings object[]required
untranslated_flag is an ExtraParams flag or word that has no Compose equivalent here. untranslated_field is a template field or entry that could not be carried over. flagged_path is a host path outside the pool and the cache. missing_network is a custom network the template names. conflict is two entries for one target with different values. writable_layer is the warning every conversion carries about state inside the source container. note is informational.
Possible values: [untranslated_flag, untranslated_field, flagged_path, missing_network, conflict, writable_layer, note]
Plain-language explanation.
The flag, path, network name or entry concerned.
Only on missing_network: the docker network create command. In a conversion it holds <PLACEHOLDER> values for what the template does not say; in an install plan it is the exact docker network create <name> for the network that was chosen.
privileges object[]required
The privilege summary of the generated Compose content. Empty when it asks for nothing beyond an ordinary container.
Possible values: [privileged, host_network, host_pid, host_cgroup, device_cgroup_rules, added_capabilities, confinement_disabled, group_add, docker_socket, host_path, gpu_reservation, container_runtime]
The Compose service that asks for it.
The path, process namespace, rules, capabilities, security options, groups, device reservations or runtime concerned, comma-separated when there are several (the entries of gpu_reservation are separated by a semicolon, each one listing its own driver, count or device ids and capabilities with commas); absent for privileged, host_network and host_cgroup.
Plain-language explanation of what it grants.
metadata objectrequired
The template's <Name>.
The template's <WebUI> as written, Unraid placeholders included.
The template's <Icon> address as written. Never fetched here.
variables object[]required
The template's environment variables with their descriptions, for an install form.
The template marks the value as masked.
{
"source": "string",
"compose": "string",
"clean": true,
"warnings": [
{
"class": "untranslated_flag",
"message": "string",
"detail": "string",
"command": "string"
}
],
"privileges": [
{
"kind": "privileged",
"service": "string",
"detail": "string",
"description": "string"
}
],
"metadata": {
"title": "string",
"overview": "string",
"category": "string",
"support": "string",
"project": "string",
"webui": "string",
"icon": "string",
"requires": "string",
"donateLink": "string",
"variables": [
{
"name": "string",
"value": "string",
"description": "string",
"secret": true
}
]
}
}