TrueNAS
Products
Support & Resources
Solutions
Company

TrueNAS Apps Market

Expand your system's capabilities quickly and easily by adding third-party software.

Download TrueNAS
TrueNAS UI and Apps screens

Prometheus Deployment

← App Details

Support and documentation for applications within the Stable catalog is handled by the TrueNAS community. The TrueNAS Applications Portal hosts but does not validate or maintain any linked resources associated with this app.

We welcome community contributions to keep this documentation current! Click Edit Page in the top right corner to propose changes to this article.

Prometheus is a monitoring platform that collects metrics from targets it monitors. Targets are system HTTP endpoints configured in the Prometheus web UI. Prometheus is itself an HTTP endpoint so it can monitor itself.

Read full post gdoc_arrow_right_alt

Prowlarr

← Catalog
10,000 active deployments icon
Prowlarr
Get Started with Apps!
Requires TrueNAS: 24.10.2.2 or newer
App Version: 2.3.5.5318 (Changelog)
Keywords: indexer
Train: Community
Home Page: https://prowlarr.com
Prowlarr Details
Added: 2024-07-31
Last Updated: 2026-04-03

Prowlarr is an indexer manager/proxy to integrate with your various PVR apps.

Run as Context
  • Container [prowlarr] can run as any non-root user and group.
    Group: 568 / Host group is [apps]
    User: 568 / Host user is [apps]

Screenshots
Screenshot 1

App Metadata (Raw File)
{
    "1.5.6": {
        "healthy": true,
        "supported": true,
        "healthy_error": null,
        "location": "/__w/apps/apps/trains/community/prowlarr/1.5.6",
        "last_update": "2026-04-03 12:46:56",
        "required_features": [],
        "human_version": "2.3.5.5318_1.5.6",
        "version": "1.5.6",
        "app_metadata": {
            "annotations": {
                "min_scale_version": "24.10.2.2"
            },
            "app_version": "2.3.5.5318",
            "capabilities": [],
            "categories": [
                "media"
            ],
            "changelog_url": "https://github.com/Prowlarr/Prowlarr/releases",
            "date_added": "2024-07-31",
            "description": "Prowlarr is an indexer manager/proxy to integrate with your various PVR apps.",
            "home": "https://prowlarr.com",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/prowlarr/icons/icon.png",
            "keywords": [
                "indexer"
            ],
            "lib_version": "2.3.1",
            "lib_version_hash": "561017357f22eafbedca2a97f747325cb83149fe1b5f765a2fbda71ab77d96ed",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "prowlarr",
            "run_as_context": [
                {
                    "description": "Container [prowlarr] can run as any non-root user and group.",
                    "gid": 568,
                    "group_name": "Host group is [apps]",
                    "uid": 568,
                    "user_name": "Host user is [apps]"
                }
            ],
            "screenshots": [
                "https://media.sys.truenas.net/apps/prowlarr/screenshots/screenshot1.png"
            ],
            "sources": [
                "https://github.com/home-operations/containers/tree/main/apps/prowlarr",
                "https://prowlarr.com"
            ],
            "title": "Prowlarr",
            "train": "community",
            "version": "1.5.6"
        },
        "schema": {
            "groups": [
                {
                    "name": "Prowlarr Configuration",
                    "description": "Configure Prowlarr"
                },
                {
                    "name": "User and Group Configuration",
                    "description": "Configure User and Group for Prowlarr"
                },
                {
                    "name": "Network Configuration",
                    "description": "Configure Network for Prowlarr"
                },
                {
                    "name": "Storage Configuration",
                    "description": "Configure Storage for Prowlarr"
                },
                {
                    "name": "Labels Configuration",
                    "description": "Configure Labels for Prowlarr"
                },
                {
                    "name": "Resources Configuration",
                    "description": "Configure Resources for Prowlarr"
                }
            ],
            "questions": [
                {
                    "variable": "TZ",
                    "group": "Prowlarr Configuration",
                    "label": "Timezone",
                    "schema": {
                        "type": "string",
                        "default": "Etc/UTC",
                        "required": true,
                        "$ref": [
                            "definitions/timezone"
                        ]
                    }
                },
                {
                    "variable": "prowlarr",
                    "label": "",
                    "group": "Prowlarr Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "instance_name",
                                "label": "Instance Name",
                                "description": "The name of the Prowlarr instance.",
                                "schema": {
                                    "type": "string",
                                    "default": "Prowlarr",
                                    "required": true
                                }
                            },
                            {
                                "variable": "additional_envs",
                                "label": "Additional Environment Variables",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "env",
                                            "label": "Environment Variable",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "value",
                                                        "label": "Value",
                                                        "schema": {
                                                            "type": "string"
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "run_as",
                    "label": "",
                    "group": "User and Group Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "user",
                                "label": "User ID",
                                "description": "The user id that Prowlarr files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            },
                            {
                                "variable": "group",
                                "label": "Group ID",
                                "description": "The group id that Prowlarr files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "network",
                    "label": "",
                    "group": "Network Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "web_port",
                                "label": "WebUI Port",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "bind_mode",
                                            "label": "Port Bind Mode",
                                            "description": "The port bind mode.</br>\n- Publish: The port will be published on the host for external access.</br>\n- Expose: The port will be exposed for inter-container communication.</br>\n- None: The port will not be exposed or published.</br>\nNote: If the Dockerfile defines an EXPOSE directive,\nthe port will still be exposed for inter-container communication regardless of this setting.\n",
                                            "schema": {
                                                "type": "string",
                                                "default": "published",
                                                "enum": [
                                                    {
                                                        "value": "published",
                                                        "description": "Publish port on the host for external access"
                                                    },
                                                    {
                                                        "value": "exposed",
                                                        "description": "Expose port for inter-container communication"
                                                    },
                                                    {
                                                        "value": "",
                                                        "description": "None"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "port_number",
                                            "label": "Port Number",
                                            "schema": {
                                                "type": "int",
                                                "default": 30050,
                                                "min": 1,
                                                "max": 65535,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "host_ips",
                                            "label": "Host IPs",
                                            "description": "IPs on the host to bind this port",
                                            "schema": {
                                                "type": "list",
                                                "show_if": [
                                                    [
                                                        "bind_mode",
                                                        "=",
                                                        "published"
                                                    ]
                                                ],
                                                "default": [],
                                                "items": [
                                                    {
                                                        "variable": "host_ip",
                                                        "label": "Host IP",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "$ref": [
                                                                "definitions/node_bind_ip"
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "networks",
                                "label": "Networks",
                                "description": "The docker networks to join",
                                "schema": {
                                    "type": "list",
                                    "show_if": [
                                        [
                                            "host_network",
                                            "=",
                                            false
                                        ]
                                    ],
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "network",
                                            "label": "Network",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "description": "The name of the network to join.</br>\nThe network must already exist.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "default": "",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "containers",
                                                        "label": "Containers",
                                                        "description": "The containers to add to this network.",
                                                        "schema": {
                                                            "type": "list",
                                                            "items": [
                                                                {
                                                                    "variable": "container",
                                                                    "label": "Container",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "attrs": [
                                                                            {
                                                                                "variable": "name",
                                                                                "label": "Container Name",
                                                                                "schema": {
                                                                                    "type": "string",
                                                                                    "required": true,
                                                                                    "enum": [
                                                                                        {
                                                                                            "value": "prowlarr",
                                                                                            "description": "prowlarr"
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            },
                                                                            {
                                                                                "variable": "config",
                                                                                "label": "Container Network Configuration",
                                                                                "schema": {
                                                                                    "type": "dict",
                                                                                    "attrs": [
                                                                                        {
                                                                                            "variable": "aliases",
                                                                                            "label": "Aliases (Optional)",
                                                                                            "description": "The network aliases to use for this container on this network.",
                                                                                            "schema": {
                                                                                                "type": "list",
                                                                                                "default": [],
                                                                                                "items": [
                                                                                                    {
                                                                                                        "variable": "alias",
                                                                                                        "label": "Alias",
                                                                                                        "schema": {
                                                                                                            "type": "string"
                                                                                                        }
                                                                                                    }
                                                                                                ]
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "interface_name",
                                                                                            "label": "Interface Name (Optional)",
                                                                                            "description": "The network interface name to use for this network",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "mac_address",
                                                                                            "label": "MAC Address (Optional)",
                                                                                            "description": "The MAC address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "ipv4_address",
                                                                                            "label": "IPv4 Address (Optional)",
                                                                                            "description": "The IPv4 address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "ipv6_address",
                                                                                            "label": "IPv6 Address (Optional)",
                                                                                            "description": "The IPv6 address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "gw_priority",
                                                                                            "label": "Gateway Priority (Optional)",
                                                                                            "description": "Indicates the priority of the gateway for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "int",
                                                                                                "null": true
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "priority",
                                                                                            "label": "Priority (Optional)",
                                                                                            "description": "Indicates in which order Compose connects the service's containers to its networks.",
                                                                                            "schema": {
                                                                                                "type": "int",
                                                                                                "null": true
                                                                                            }
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            }
                                                                        ]
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "host_network",
                                "label": "Host Network",
                                "description": "Bind to the host network. It's recommended to keep this disabled.\n",
                                "schema": {
                                    "type": "boolean",
                                    "default": false
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "storage",
                    "label": "",
                    "group": "Storage Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "config",
                                "label": "Prowlarr Config Storage",
                                "description": "The path to store Prowlarr Config.",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "type",
                                            "label": "Type",
                                            "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
                                            "schema": {
                                                "type": "string",
                                                "required": true,
                                                "default": "ix_volume",
                                                "enum": [
                                                    {
                                                        "value": "host_path",
                                                        "description": "Host Path (Path that already exists on the system)"
                                                    },
                                                    {
                                                        "value": "ix_volume",
                                                        "description": "ixVolume (Dataset created automatically by the system)"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "ix_volume_config",
                                            "label": "ixVolume Configuration",
                                            "description": "The configuration for the ixVolume dataset.",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "ix_volume"
                                                    ]
                                                ],
                                                "$ref": [
                                                    "normalize/ix_volume"
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "dataset_name",
                                                        "label": "Dataset Name",
                                                        "description": "The name of the dataset to use for storage.",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "hidden": true,
                                                            "default": "config"
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl_entries",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": []
                                                        }
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "host_path_config",
                                            "label": "Host Path Configuration",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "host_path"
                                                    ]
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": [],
                                                            "$ref": [
                                                                "normalize/acl"
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "path",
                                                        "label": "Host Path",
                                                        "description": "The host path to use for storage.",
                                                        "schema": {
                                                            "type": "hostpath",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    false
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "additional_storage",
                                "label": "Additional Storage",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "storageEntry",
                                            "label": "Storage Entry",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "type",
                                                        "label": "Type",
                                                        "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.</br>\nNFS Share: Is a NFS share that is mounted to as a volume.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "default": "ix_volume",
                                                            "enum": [
                                                                {
                                                                    "value": "host_path",
                                                                    "description": "Host Path (Path that already exists on the system)"
                                                                },
                                                                {
                                                                    "value": "ix_volume",
                                                                    "description": "ixVolume (Dataset created automatically by the system)"
                                                                },
                                                                {
                                                                    "value": "cifs",
                                                                    "description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
                                                                },
                                                                {
                                                                    "value": "nfs",
                                                                    "description": "NFS Share (Mounts a volume to a NFS share)"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "read_only",
                                                        "label": "Read Only",
                                                        "description": "Mount the volume as read only.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "mount_path",
                                                        "label": "Mount Path",
                                                        "description": "The path inside the container to mount the storage.",
                                                        "schema": {
                                                            "type": "path",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "host_path_config",
                                                        "label": "Host Path Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "host_path"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Host Path",
                                                                    "description": "The host path to use for storage.",
                                                                    "schema": {
                                                                        "type": "hostpath",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                false
                                                                            ]
                                                                        ],
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "ix_volume_config",
                                                        "label": "ixVolume Configuration",
                                                        "description": "The configuration for the ixVolume dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "ix_volume"
                                                                ]
                                                            ],
                                                            "$ref": [
                                                                "normalize/ix_volume"
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "dataset_name",
                                                                    "label": "Dataset Name",
                                                                    "description": "The name of the dataset to use for storage.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "default": "storage_entry"
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl_entries",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "cifs_config",
                                                        "label": "SMB Configuration",
                                                        "description": "The configuration for the SMB dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "cifs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "username",
                                                                    "label": "Username",
                                                                    "description": "The username to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "password",
                                                                    "label": "Password",
                                                                    "description": "The password to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "private": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "domain",
                                                                    "label": "Domain",
                                                                    "description": "The domain to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string"
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "nfs_config",
                                                        "label": "NFS Configuration",
                                                        "description": "The configuration for the NFS dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "nfs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "labels",
                    "label": "",
                    "group": "Labels Configuration",
                    "schema": {
                        "type": "list",
                        "default": [],
                        "items": [
                            {
                                "variable": "label",
                                "label": "Label",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "key",
                                            "label": "Key",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "value",
                                            "label": "Value",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "containers",
                                            "label": "Containers",
                                            "description": "Containers where the label should be applied",
                                            "schema": {
                                                "type": "list",
                                                "items": [
                                                    {
                                                        "variable": "container",
                                                        "label": "Container",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "enum": [
                                                                {
                                                                    "value": "prowlarr",
                                                                    "description": "prowlarr"
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "resources",
                    "label": "",
                    "group": "Resources Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "limits",
                                "label": "Limits",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "cpus",
                                            "label": "CPUs",
                                            "description": "CPUs limit for Prowlarr.",
                                            "schema": {
                                                "type": "int",
                                                "default": 2,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "memory",
                                            "label": "Memory (in MB)",
                                            "description": "Memory limit for Prowlarr.",
                                            "schema": {
                                                "type": "int",
                                                "default": 4096,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        },
        "readme": "<h1>Prowlarr</h1> <p><a href=\"https://github.com/Prowlarr/Prowlarr\">Prowlarr</a> is a music collection manager for Usenet and BitTorrent users.</p>",
        "changelog": null,
        "chart_metadata": {
            "annotations": {
                "min_scale_version": "24.10.2.2"
            },
            "app_version": "2.3.5.5318",
            "capabilities": [],
            "categories": [
                "media"
            ],
            "changelog_url": "https://github.com/Prowlarr/Prowlarr/releases",
            "date_added": "2024-07-31",
            "description": "Prowlarr is an indexer manager/proxy to integrate with your various PVR apps.",
            "home": "https://prowlarr.com",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/prowlarr/icons/icon.png",
            "keywords": [
                "indexer"
            ],
            "lib_version": "2.3.1",
            "lib_version_hash": "561017357f22eafbedca2a97f747325cb83149fe1b5f765a2fbda71ab77d96ed",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "prowlarr",
            "run_as_context": [
                {
                    "description": "Container [prowlarr] can run as any non-root user and group.",
                    "gid": 568,
                    "group_name": "Host group is [apps]",
                    "uid": 568,
                    "user_name": "Host user is [apps]"
                }
            ],
            "screenshots": [
                "https://media.sys.truenas.net/apps/prowlarr/screenshots/screenshot1.png"
            ],
            "sources": [
                "https://github.com/home-operations/containers/tree/main/apps/prowlarr",
                "https://prowlarr.com"
            ],
            "title": "Prowlarr",
            "train": "community",
            "version": "1.5.6"
        }
    }
}

Resources

Read full post gdoc_arrow_right_alt
11 minutes to read apps

qBittorrent

← Catalog
10,000 active deployments icon
qBittorrent
Get Started with Apps!
Requires TrueNAS: 24.10.2.2 or newer
App Version: 5.1.4 (Changelog)
Keywords: media, torrent, download
Train: Community
Home Page: https://www.qbittorrent.org/
qBittorrent Details
Added: 2024-07-30
Last Updated: 2026-04-03

The qBittorrent project aims to provide an open-source software alternative to mTorrent.

Run as Context
  • Container [qbittorrent] can run as any non-root user and group.
    Group: 568 / Host group is [apps]
    User: 568 / Host user is [apps]
⚠️

Feature Deprecation Notice

qBittorrent: qBittorrent version 4.x.x

Read full post gdoc_arrow_right_alt
14 minutes to read apps

Radarr

← Catalog
10,000 active deployments icon
Radarr
Get Started with Apps!
Requires TrueNAS: 24.10.2.2 or newer
App Version: 6.1.2.10359 (Changelog)
Keywords: media, movies
Train: Community
Home Page: https://github.com/Radarr/Radarr
Radarr Details
Added: 2024-07-30
Last Updated: 2026-04-03

Radarr is a movie collection manager for Usenet and BitTorrent users.

Run as Context
  • Container [radarr] can run as any non-root user and group.
    Group: 568 / Host group is [apps]
    User: 568 / Host user is [apps]

Screenshots
Screenshot 1 Screenshot 2 Screenshot 3 Screenshot 4

App Metadata (Raw File)
{
    "1.4.4": {
        "healthy": true,
        "supported": true,
        "healthy_error": null,
        "location": "/__w/apps/apps/trains/community/radarr/1.4.4",
        "last_update": "2026-04-03 12:46:56",
        "required_features": [],
        "human_version": "6.1.2.10359_1.4.4",
        "version": "1.4.4",
        "app_metadata": {
            "annotations": {
                "min_scale_version": "24.10.2.2"
            },
            "app_version": "6.1.2.10359",
            "capabilities": [],
            "categories": [
                "media"
            ],
            "changelog_url": "https://github.com/Radarr/Radarr/releases",
            "date_added": "2024-07-30",
            "description": "Radarr is a movie collection manager for Usenet and BitTorrent users.",
            "home": "https://github.com/Radarr/Radarr",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/radarr/icons/icon.png",
            "keywords": [
                "media",
                "movies"
            ],
            "lib_version": "2.3.1",
            "lib_version_hash": "561017357f22eafbedca2a97f747325cb83149fe1b5f765a2fbda71ab77d96ed",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "radarr",
            "run_as_context": [
                {
                    "description": "Container [radarr] can run as any non-root user and group.",
                    "gid": 568,
                    "group_name": "Host group is [apps]",
                    "uid": 568,
                    "user_name": "Host user is [apps]"
                }
            ],
            "screenshots": [
                "https://media.sys.truenas.net/apps/radarr/screenshots/screenshot1.png",
                "https://media.sys.truenas.net/apps/radarr/screenshots/screenshot2.png",
                "https://media.sys.truenas.net/apps/radarr/screenshots/screenshot3.png",
                "https://media.sys.truenas.net/apps/radarr/screenshots/screenshot4.png"
            ],
            "sources": [
                "https://github.com/home-operations/containers/tree/main/apps/radarr",
                "https://github.com/Radarr/Radarr"
            ],
            "title": "Radarr",
            "train": "community",
            "version": "1.4.4"
        },
        "schema": {
            "groups": [
                {
                    "name": "Radarr Configuration",
                    "description": "Configure Radarr"
                },
                {
                    "name": "User and Group Configuration",
                    "description": "Configure User and Group for Radarr"
                },
                {
                    "name": "Network Configuration",
                    "description": "Configure Network for Radarr"
                },
                {
                    "name": "Storage Configuration",
                    "description": "Configure Storage for Radarr"
                },
                {
                    "name": "Labels Configuration",
                    "description": "Configure Labels for Radarr"
                },
                {
                    "name": "Resources Configuration",
                    "description": "Configure Resources for Radarr"
                }
            ],
            "questions": [
                {
                    "variable": "TZ",
                    "group": "Radarr Configuration",
                    "label": "Timezone",
                    "schema": {
                        "type": "string",
                        "default": "Etc/UTC",
                        "required": true,
                        "$ref": [
                            "definitions/timezone"
                        ]
                    }
                },
                {
                    "variable": "radarr",
                    "label": "",
                    "group": "Radarr Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "instance_name",
                                "label": "Instance Name",
                                "description": "The name of the Radarr instance.",
                                "schema": {
                                    "type": "string",
                                    "default": "Radarr",
                                    "required": true
                                }
                            },
                            {
                                "variable": "additional_envs",
                                "label": "Additional Environment Variables",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "env",
                                            "label": "Environment Variable",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "value",
                                                        "label": "Value",
                                                        "schema": {
                                                            "type": "string"
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "run_as",
                    "label": "",
                    "group": "User and Group Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "user",
                                "label": "User ID",
                                "description": "The user id that Radarr files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            },
                            {
                                "variable": "group",
                                "label": "Group ID",
                                "description": "The group id that Radarr files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "network",
                    "label": "",
                    "group": "Network Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "web_port",
                                "label": "WebUI Port",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "bind_mode",
                                            "label": "Port Bind Mode",
                                            "description": "The port bind mode.</br>\n- Publish: The port will be published on the host for external access.</br>\n- Expose: The port will be exposed for inter-container communication.</br>\n- None: The port will not be exposed or published.</br>\nNote: If the Dockerfile defines an EXPOSE directive,\nthe port will still be exposed for inter-container communication regardless of this setting.\n",
                                            "schema": {
                                                "type": "string",
                                                "default": "published",
                                                "enum": [
                                                    {
                                                        "value": "published",
                                                        "description": "Publish port on the host for external access"
                                                    },
                                                    {
                                                        "value": "exposed",
                                                        "description": "Expose port for inter-container communication"
                                                    },
                                                    {
                                                        "value": "",
                                                        "description": "None"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "port_number",
                                            "label": "Port Number",
                                            "schema": {
                                                "type": "int",
                                                "default": 30025,
                                                "min": 1,
                                                "max": 65535,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "host_ips",
                                            "label": "Host IPs",
                                            "description": "IPs on the host to bind this port",
                                            "schema": {
                                                "type": "list",
                                                "show_if": [
                                                    [
                                                        "bind_mode",
                                                        "=",
                                                        "published"
                                                    ]
                                                ],
                                                "default": [],
                                                "items": [
                                                    {
                                                        "variable": "host_ip",
                                                        "label": "Host IP",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "$ref": [
                                                                "definitions/node_bind_ip"
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "networks",
                                "label": "Networks",
                                "description": "The docker networks to join",
                                "schema": {
                                    "type": "list",
                                    "show_if": [
                                        [
                                            "host_network",
                                            "=",
                                            false
                                        ]
                                    ],
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "network",
                                            "label": "Network",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "description": "The name of the network to join.</br>\nThe network must already exist.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "default": "",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "containers",
                                                        "label": "Containers",
                                                        "description": "The containers to add to this network.",
                                                        "schema": {
                                                            "type": "list",
                                                            "items": [
                                                                {
                                                                    "variable": "container",
                                                                    "label": "Container",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "attrs": [
                                                                            {
                                                                                "variable": "name",
                                                                                "label": "Container Name",
                                                                                "schema": {
                                                                                    "type": "string",
                                                                                    "required": true,
                                                                                    "enum": [
                                                                                        {
                                                                                            "value": "radarr",
                                                                                            "description": "radarr"
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            },
                                                                            {
                                                                                "variable": "config",
                                                                                "label": "Container Network Configuration",
                                                                                "schema": {
                                                                                    "type": "dict",
                                                                                    "attrs": [
                                                                                        {
                                                                                            "variable": "aliases",
                                                                                            "label": "Aliases (Optional)",
                                                                                            "description": "The network aliases to use for this container on this network.",
                                                                                            "schema": {
                                                                                                "type": "list",
                                                                                                "default": [],
                                                                                                "items": [
                                                                                                    {
                                                                                                        "variable": "alias",
                                                                                                        "label": "Alias",
                                                                                                        "schema": {
                                                                                                            "type": "string"
                                                                                                        }
                                                                                                    }
                                                                                                ]
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "interface_name",
                                                                                            "label": "Interface Name (Optional)",
                                                                                            "description": "The network interface name to use for this network",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "mac_address",
                                                                                            "label": "MAC Address (Optional)",
                                                                                            "description": "The MAC address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "ipv4_address",
                                                                                            "label": "IPv4 Address (Optional)",
                                                                                            "description": "The IPv4 address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "ipv6_address",
                                                                                            "label": "IPv6 Address (Optional)",
                                                                                            "description": "The IPv6 address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "gw_priority",
                                                                                            "label": "Gateway Priority (Optional)",
                                                                                            "description": "Indicates the priority of the gateway for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "int",
                                                                                                "null": true
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "priority",
                                                                                            "label": "Priority (Optional)",
                                                                                            "description": "Indicates in which order Compose connects the service's containers to its networks.",
                                                                                            "schema": {
                                                                                                "type": "int",
                                                                                                "null": true
                                                                                            }
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            }
                                                                        ]
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "host_network",
                                "label": "Host Network",
                                "description": "Bind to the host network. It's recommended to keep this disabled.\n",
                                "schema": {
                                    "type": "boolean",
                                    "default": false
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "storage",
                    "label": "",
                    "group": "Storage Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "config",
                                "label": "Radarr Config Storage",
                                "description": "The path to store Radarr Config.",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "type",
                                            "label": "Type",
                                            "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
                                            "schema": {
                                                "type": "string",
                                                "required": true,
                                                "default": "ix_volume",
                                                "enum": [
                                                    {
                                                        "value": "host_path",
                                                        "description": "Host Path (Path that already exists on the system)"
                                                    },
                                                    {
                                                        "value": "ix_volume",
                                                        "description": "ixVolume (Dataset created automatically by the system)"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "ix_volume_config",
                                            "label": "ixVolume Configuration",
                                            "description": "The configuration for the ixVolume dataset.",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "ix_volume"
                                                    ]
                                                ],
                                                "$ref": [
                                                    "normalize/ix_volume"
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "dataset_name",
                                                        "label": "Dataset Name",
                                                        "description": "The name of the dataset to use for storage.",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "hidden": true,
                                                            "default": "config"
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl_entries",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": []
                                                        }
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "host_path_config",
                                            "label": "Host Path Configuration",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "host_path"
                                                    ]
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": [],
                                                            "$ref": [
                                                                "normalize/acl"
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "path",
                                                        "label": "Host Path",
                                                        "description": "The host path to use for storage.",
                                                        "schema": {
                                                            "type": "hostpath",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    false
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "additional_storage",
                                "label": "Additional Storage",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "storageEntry",
                                            "label": "Storage Entry",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "type",
                                                        "label": "Type",
                                                        "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.</br>\nNFS Share: Is a NFS share that is mounted to as a volume.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "default": "ix_volume",
                                                            "enum": [
                                                                {
                                                                    "value": "host_path",
                                                                    "description": "Host Path (Path that already exists on the system)"
                                                                },
                                                                {
                                                                    "value": "ix_volume",
                                                                    "description": "ixVolume (Dataset created automatically by the system)"
                                                                },
                                                                {
                                                                    "value": "cifs",
                                                                    "description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
                                                                },
                                                                {
                                                                    "value": "nfs",
                                                                    "description": "NFS Share (Mounts a volume to a NFS share)"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "read_only",
                                                        "label": "Read Only",
                                                        "description": "Mount the volume as read only.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "mount_path",
                                                        "label": "Mount Path",
                                                        "description": "The path inside the container to mount the storage.",
                                                        "schema": {
                                                            "type": "path",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "host_path_config",
                                                        "label": "Host Path Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "host_path"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Host Path",
                                                                    "description": "The host path to use for storage.",
                                                                    "schema": {
                                                                        "type": "hostpath",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                false
                                                                            ]
                                                                        ],
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "ix_volume_config",
                                                        "label": "ixVolume Configuration",
                                                        "description": "The configuration for the ixVolume dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "ix_volume"
                                                                ]
                                                            ],
                                                            "$ref": [
                                                                "normalize/ix_volume"
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "dataset_name",
                                                                    "label": "Dataset Name",
                                                                    "description": "The name of the dataset to use for storage.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "default": "storage_entry"
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl_entries",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "cifs_config",
                                                        "label": "SMB Configuration",
                                                        "description": "The configuration for the SMB dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "cifs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "username",
                                                                    "label": "Username",
                                                                    "description": "The username to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "password",
                                                                    "label": "Password",
                                                                    "description": "The password to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "private": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "domain",
                                                                    "label": "Domain",
                                                                    "description": "The domain to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string"
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "nfs_config",
                                                        "label": "NFS Configuration",
                                                        "description": "The configuration for the NFS dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "nfs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "labels",
                    "label": "",
                    "group": "Labels Configuration",
                    "schema": {
                        "type": "list",
                        "default": [],
                        "items": [
                            {
                                "variable": "label",
                                "label": "Label",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "key",
                                            "label": "Key",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "value",
                                            "label": "Value",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "containers",
                                            "label": "Containers",
                                            "description": "Containers where the label should be applied",
                                            "schema": {
                                                "type": "list",
                                                "items": [
                                                    {
                                                        "variable": "container",
                                                        "label": "Container",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "enum": [
                                                                {
                                                                    "value": "radarr",
                                                                    "description": "radarr"
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "resources",
                    "label": "",
                    "group": "Resources Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "limits",
                                "label": "Limits",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "cpus",
                                            "label": "CPUs",
                                            "description": "CPUs limit for Radarr.",
                                            "schema": {
                                                "type": "int",
                                                "default": 2,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "memory",
                                            "label": "Memory (in MB)",
                                            "description": "Memory limit for Radarr.",
                                            "schema": {
                                                "type": "int",
                                                "default": 4096,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        },
        "readme": "<h1>Radarr</h1> <p><a href=\"https://github.com/Radarr/Radarr\">Radarr</a> is a movie collection manager for Usenet and BitTorrent users.</p>",
        "changelog": null,
        "chart_metadata": {
            "annotations": {
                "min_scale_version": "24.10.2.2"
            },
            "app_version": "6.1.2.10359",
            "capabilities": [],
            "categories": [
                "media"
            ],
            "changelog_url": "https://github.com/Radarr/Radarr/releases",
            "date_added": "2024-07-30",
            "description": "Radarr is a movie collection manager for Usenet and BitTorrent users.",
            "home": "https://github.com/Radarr/Radarr",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/radarr/icons/icon.png",
            "keywords": [
                "media",
                "movies"
            ],
            "lib_version": "2.3.1",
            "lib_version_hash": "561017357f22eafbedca2a97f747325cb83149fe1b5f765a2fbda71ab77d96ed",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "radarr",
            "run_as_context": [
                {
                    "description": "Container [radarr] can run as any non-root user and group.",
                    "gid": 568,
                    "group_name": "Host group is [apps]",
                    "uid": 568,
                    "user_name": "Host user is [apps]"
                }
            ],
            "screenshots": [
                "https://media.sys.truenas.net/apps/radarr/screenshots/screenshot1.png",
                "https://media.sys.truenas.net/apps/radarr/screenshots/screenshot2.png",
                "https://media.sys.truenas.net/apps/radarr/screenshots/screenshot3.png",
                "https://media.sys.truenas.net/apps/radarr/screenshots/screenshot4.png"
            ],
            "sources": [
                "https://github.com/home-operations/containers/tree/main/apps/radarr",
                "https://github.com/Radarr/Radarr"
            ],
            "title": "Radarr",
            "train": "community",
            "version": "1.4.4"
        }
    }
}

Resources

Read full post gdoc_arrow_right_alt
11 minutes to read apps

Readarr

← Catalog
1,000 active deployments icon
Readarr (Deprecated)
Get Started with Apps!
Requires TrueNAS: 24.10.2.2 or newer
App Version: 0.4.18.2805 (Changelog)
Keywords: media, ebook, audiobook
Train: Community
Home Page: https://github.com/Readarr/Readarr
Readarr (Deprecated) Details
Added: 2024-07-31
Last Updated: 2025-10-06

Readarr is an ebook and audiobook collection manager for Usenet and BitTorrent users.

Run as Context
  • Readarr runs as any non-root user.
    Group: 568 / readarr
    User: 568 / readarr

Screenshots
Screenshot 1 Screenshot 2 Screenshot 3

App Metadata (Raw File)
{
    "1.2.15": {
        "healthy": true,
        "supported": true,
        "healthy_error": null,
        "location": "/__w/apps/apps/trains/community/readarr/1.2.15",
        "last_update": "2025-10-06 12:19:46",
        "required_features": [],
        "human_version": "0.4.18.2805_1.2.15",
        "version": "1.2.15",
        "app_metadata": {
            "annotations": {
                "min_scale_version": "24.10.2.2"
            },
            "app_version": "0.4.18.2805",
            "capabilities": [],
            "categories": [
                "media"
            ],
            "changelog_url": "https://github.com/Readarr/Readarr/releases",
            "date_added": "2024-07-31",
            "description": "Readarr is an ebook and audiobook collection manager for Usenet and BitTorrent users.",
            "home": "https://github.com/Readarr/Readarr",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/readarr/icons/icon.png",
            "keywords": [
                "media",
                "ebook",
                "audiobook"
            ],
            "lib_version": "2.1.57",
            "lib_version_hash": "6659ad369fff2f1df318cb6353bb32bffe7047dc21df4823750d39be7284e605",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "readarr",
            "run_as_context": [
                {
                    "description": "Readarr runs as any non-root user.",
                    "gid": 568,
                    "group_name": "readarr",
                    "uid": 568,
                    "user_name": "readarr"
                }
            ],
            "screenshots": [
                "https://media.sys.truenas.net/apps/readarr/screenshots/screenshot1.png",
                "https://media.sys.truenas.net/apps/readarr/screenshots/screenshot2.png",
                "https://media.sys.truenas.net/apps/readarr/screenshots/screenshot3.png"
            ],
            "sources": [
                "https://github.com/Readarr/Readarr",
                "https://github.com/home-operations/containers/tree/main/apps/readarr"
            ],
            "title": "Readarr (Deprecated)",
            "train": "community",
            "version": "1.2.15"
        },
        "schema": {
            "groups": [
                {
                    "name": "Readarr Configuration",
                    "description": "Configure Readarr"
                },
                {
                    "name": "User and Group Configuration",
                    "description": "Configure User and Group for Readarr"
                },
                {
                    "name": "Network Configuration",
                    "description": "Configure Network for Readarr"
                },
                {
                    "name": "Storage Configuration",
                    "description": "Configure Storage for Readarr"
                },
                {
                    "name": "Labels Configuration",
                    "description": "Configure Labels for Readarr"
                },
                {
                    "name": "Resources Configuration",
                    "description": "Configure Resources for Readarr"
                }
            ],
            "questions": [
                {
                    "variable": "readarr",
                    "label": "",
                    "group": "Readarr Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "instance_name",
                                "label": "Instance Name",
                                "description": "The name of the Readarr instance.",
                                "schema": {
                                    "type": "string",
                                    "default": "Readarr",
                                    "required": true
                                }
                            },
                            {
                                "variable": "additional_envs",
                                "label": "Additional Environment Variables",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "env",
                                            "label": "Environment Variable",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "value",
                                                        "label": "Value",
                                                        "schema": {
                                                            "type": "string"
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "run_as",
                    "label": "",
                    "group": "User and Group Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "user",
                                "label": "User ID",
                                "description": "The user id that Readarr files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            },
                            {
                                "variable": "group",
                                "label": "Group ID",
                                "description": "The group id that Readarr files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "network",
                    "label": "",
                    "group": "Network Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "web_port",
                                "label": "WebUI Port",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "bind_mode",
                                            "label": "Port Bind Mode",
                                            "description": "The port bind mode.</br>\n- Publish: The port will be published on the host for external access.</br>\n- Expose: The port will be exposed for inter-container communication.</br>\n- None: The port will not be exposed or published.</br>\nNote: If the Dockerfile defines an EXPOSE directive,\nthe port will still be exposed for inter-container communication regardless of this setting.\n",
                                            "schema": {
                                                "type": "string",
                                                "default": "published",
                                                "enum": [
                                                    {
                                                        "value": "published",
                                                        "description": "Publish port on the host for external access"
                                                    },
                                                    {
                                                        "value": "exposed",
                                                        "description": "Expose port for inter-container communication"
                                                    },
                                                    {
                                                        "value": "",
                                                        "description": "None"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "port_number",
                                            "label": "Port Number",
                                            "schema": {
                                                "type": "int",
                                                "default": 30045,
                                                "min": 1,
                                                "max": 65535,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "host_ips",
                                            "label": "Host IPs",
                                            "description": "IPs on the host to bind this port",
                                            "schema": {
                                                "type": "list",
                                                "show_if": [
                                                    [
                                                        "bind_mode",
                                                        "=",
                                                        "published"
                                                    ]
                                                ],
                                                "default": [],
                                                "items": [
                                                    {
                                                        "variable": "host_ip",
                                                        "label": "Host IP",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "$ref": [
                                                                "definitions/node_bind_ip"
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "host_network",
                                "label": "Host Network",
                                "description": "Bind to the host network. It's recommended to keep this disabled.\n",
                                "schema": {
                                    "type": "boolean",
                                    "default": false
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "storage",
                    "label": "",
                    "group": "Storage Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "config",
                                "label": "Readarr Config Storage",
                                "description": "The path to store Readarr Config.",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "type",
                                            "label": "Type",
                                            "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
                                            "schema": {
                                                "type": "string",
                                                "required": true,
                                                "default": "ix_volume",
                                                "enum": [
                                                    {
                                                        "value": "host_path",
                                                        "description": "Host Path (Path that already exists on the system)"
                                                    },
                                                    {
                                                        "value": "ix_volume",
                                                        "description": "ixVolume (Dataset created automatically by the system)"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "ix_volume_config",
                                            "label": "ixVolume Configuration",
                                            "description": "The configuration for the ixVolume dataset.",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "ix_volume"
                                                    ]
                                                ],
                                                "$ref": [
                                                    "normalize/ix_volume"
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "dataset_name",
                                                        "label": "Dataset Name",
                                                        "description": "The name of the dataset to use for storage.",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "hidden": true,
                                                            "default": "config"
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl_entries",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": []
                                                        }
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "host_path_config",
                                            "label": "Host Path Configuration",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "host_path"
                                                    ]
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": [],
                                                            "$ref": [
                                                                "normalize/acl"
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "path",
                                                        "label": "Host Path",
                                                        "description": "The host path to use for storage.",
                                                        "schema": {
                                                            "type": "hostpath",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    false
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "additional_storage",
                                "label": "Additional Storage",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "storageEntry",
                                            "label": "Storage Entry",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "type",
                                                        "label": "Type",
                                                        "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.</br>\nNFS Share: Is a NFS share that is mounted to as a volume.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "default": "ix_volume",
                                                            "enum": [
                                                                {
                                                                    "value": "host_path",
                                                                    "description": "Host Path (Path that already exists on the system)"
                                                                },
                                                                {
                                                                    "value": "ix_volume",
                                                                    "description": "ixVolume (Dataset created automatically by the system)"
                                                                },
                                                                {
                                                                    "value": "cifs",
                                                                    "description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
                                                                },
                                                                {
                                                                    "value": "nfs",
                                                                    "description": "NFS Share (Mounts a volume to a NFS share)"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "read_only",
                                                        "label": "Read Only",
                                                        "description": "Mount the volume as read only.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "mount_path",
                                                        "label": "Mount Path",
                                                        "description": "The path inside the container to mount the storage.",
                                                        "schema": {
                                                            "type": "path",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "host_path_config",
                                                        "label": "Host Path Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "host_path"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Host Path",
                                                                    "description": "The host path to use for storage.",
                                                                    "schema": {
                                                                        "type": "hostpath",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                false
                                                                            ]
                                                                        ],
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "ix_volume_config",
                                                        "label": "ixVolume Configuration",
                                                        "description": "The configuration for the ixVolume dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "ix_volume"
                                                                ]
                                                            ],
                                                            "$ref": [
                                                                "normalize/ix_volume"
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "dataset_name",
                                                                    "label": "Dataset Name",
                                                                    "description": "The name of the dataset to use for storage.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "default": "storage_entry"
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl_entries",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": []
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "cifs_config",
                                                        "label": "SMB Configuration",
                                                        "description": "The configuration for the SMB dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "cifs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "username",
                                                                    "label": "Username",
                                                                    "description": "The username to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "password",
                                                                    "label": "Password",
                                                                    "description": "The password to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "private": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "domain",
                                                                    "label": "Domain",
                                                                    "description": "The domain to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string"
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "nfs_config",
                                                        "label": "NFS Configuration",
                                                        "description": "The configuration for the NFS dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "nfs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "labels",
                    "label": "",
                    "group": "Labels Configuration",
                    "schema": {
                        "type": "list",
                        "default": [],
                        "items": [
                            {
                                "variable": "label",
                                "label": "Label",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "key",
                                            "label": "Key",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "value",
                                            "label": "Value",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "containers",
                                            "label": "Containers",
                                            "description": "Containers where the label should be applied",
                                            "schema": {
                                                "type": "list",
                                                "items": [
                                                    {
                                                        "variable": "container",
                                                        "label": "Container",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "enum": [
                                                                {
                                                                    "value": "readarr",
                                                                    "description": "readarr"
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "resources",
                    "label": "",
                    "group": "Resources Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "limits",
                                "label": "Limits",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "cpus",
                                            "label": "CPUs",
                                            "description": "CPUs limit for Readarr.",
                                            "schema": {
                                                "type": "int",
                                                "default": 2,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "memory",
                                            "label": "Memory (in MB)",
                                            "description": "Memory limit for Readarr.",
                                            "schema": {
                                                "type": "int",
                                                "default": 4096,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        },
        "readme": "<h1>Readarr</h1> <p><a href=\"https://github.com/Readarr/Readarr\">Readarr</a> is an ebook and audiobook collection manager for Usenet and BitTorrent users.</p>",
        "changelog": null,
        "chart_metadata": {
            "annotations": {
                "min_scale_version": "24.10.2.2"
            },
            "app_version": "0.4.18.2805",
            "capabilities": [],
            "categories": [
                "media"
            ],
            "changelog_url": "https://github.com/Readarr/Readarr/releases",
            "date_added": "2024-07-31",
            "description": "Readarr is an ebook and audiobook collection manager for Usenet and BitTorrent users.",
            "home": "https://github.com/Readarr/Readarr",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/readarr/icons/icon.png",
            "keywords": [
                "media",
                "ebook",
                "audiobook"
            ],
            "lib_version": "2.1.57",
            "lib_version_hash": "6659ad369fff2f1df318cb6353bb32bffe7047dc21df4823750d39be7284e605",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "readarr",
            "run_as_context": [
                {
                    "description": "Readarr runs as any non-root user.",
                    "gid": 568,
                    "group_name": "readarr",
                    "uid": 568,
                    "user_name": "readarr"
                }
            ],
            "screenshots": [
                "https://media.sys.truenas.net/apps/readarr/screenshots/screenshot1.png",
                "https://media.sys.truenas.net/apps/readarr/screenshots/screenshot2.png",
                "https://media.sys.truenas.net/apps/readarr/screenshots/screenshot3.png"
            ],
            "sources": [
                "https://github.com/Readarr/Readarr",
                "https://github.com/home-operations/containers/tree/main/apps/readarr"
            ],
            "title": "Readarr (Deprecated)",
            "train": "community",
            "version": "1.2.15"
        }
    }
}

Resources

Read full post gdoc_arrow_right_alt
10 minutes to read apps

Recyclarr

← Catalog
1,000 active deployments icon
Recyclarr
Get Started with Apps!
App Version: 8.5.1 (Changelog)
Keywords: sync, sonarr, radarr
Train: Community
Home Page: https://recyclarr.dev
Recyclarr Details
Added: 2024-09-10
Last Updated: 2026-04-03

Recyclarr synchronizes recommended settings from the TRaSH guides to your Sonarr/Radarr instances.

Run as Context
  • Container [recyclarr] can run as any non-root user and group.
    Group: 568 / Host group is [apps]
    User: 568 / Host user is [apps]

App Metadata (Raw File)
{
    "1.3.12": {
        "healthy": true,
        "supported": true,
        "healthy_error": null,
        "location": "/__w/apps/apps/trains/community/recyclarr/1.3.12",
        "last_update": "2026-04-03 12:46:56",
        "required_features": [],
        "human_version": "8.5.1_1.3.12",
        "version": "1.3.12",
        "app_metadata": {
            "app_version": "8.5.1",
            "capabilities": [],
            "categories": [
                "media"
            ],
            "changelog_url": "https://github.com/recyclarr/recyclarr/blob/master/CHANGELOG.md",
            "date_added": "2024-09-10",
            "description": "Recyclarr synchronizes recommended settings from the TRaSH guides to your Sonarr/Radarr instances.",
            "home": "https://recyclarr.dev",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/recyclarr/icons/icon.png",
            "keywords": [
                "sync",
                "sonarr",
                "radarr"
            ],
            "lib_version": "2.3.1",
            "lib_version_hash": "561017357f22eafbedca2a97f747325cb83149fe1b5f765a2fbda71ab77d96ed",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "recyclarr",
            "run_as_context": [
                {
                    "description": "Container [recyclarr] can run as any non-root user and group.",
                    "gid": 568,
                    "group_name": "Host group is [apps]",
                    "uid": 568,
                    "user_name": "Host user is [apps]"
                }
            ],
            "screenshots": [],
            "sources": [
                "https://recyclarr.dev",
                "https://github.com/recyclarr/recyclarr/tree/recyclarr"
            ],
            "title": "Recyclarr",
            "train": "community",
            "version": "1.3.12"
        },
        "schema": {
            "groups": [
                {
                    "name": "Recyclarr Configuration",
                    "description": "Configure Recyclarr"
                },
                {
                    "name": "User and Group Configuration",
                    "description": "Configure User and Group for Recyclarr"
                },
                {
                    "name": "Network Configuration",
                    "description": "Configure Network for Recyclarr"
                },
                {
                    "name": "Storage Configuration",
                    "description": "Configure Storage for Recyclarr"
                },
                {
                    "name": "Labels Configuration",
                    "description": "Configure Labels for Recyclarr"
                },
                {
                    "name": "Resources Configuration",
                    "description": "Configure Resources for Recyclarr"
                }
            ],
            "questions": [
                {
                    "variable": "TZ",
                    "group": "Recyclarr Configuration",
                    "label": "Timezone",
                    "schema": {
                        "type": "string",
                        "default": "Etc/UTC",
                        "required": true,
                        "$ref": [
                            "definitions/timezone"
                        ]
                    }
                },
                {
                    "variable": "recyclarr",
                    "label": "",
                    "group": "Recyclarr Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "create_config",
                                "label": "Create Default Config",
                                "description": "Enable this if you want /config/recyclarr.yml to be created for\nyou automatically when the container starts. </br>\nIf the file already exists, it will not create the file again.\n",
                                "schema": {
                                    "type": "boolean",
                                    "default": false
                                }
                            },
                            {
                                "variable": "cron_schedule",
                                "label": "Cron Schedule",
                                "description": "The cron schedule to use for Recyclarr.\n",
                                "schema": {
                                    "type": "string",
                                    "default": "@daily",
                                    "required": true
                                }
                            },
                            {
                                "variable": "additional_envs",
                                "label": "Additional Environment Variables",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "env",
                                            "label": "Environment Variable",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "value",
                                                        "label": "Value",
                                                        "schema": {
                                                            "type": "string"
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "run_as",
                    "label": "",
                    "group": "User and Group Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "user",
                                "label": "User ID",
                                "description": "The user id that Recyclarr files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            },
                            {
                                "variable": "group",
                                "label": "Group ID",
                                "description": "The group id that Recyclarr files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "network",
                    "label": "",
                    "group": "Network Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "networks",
                                "label": "Networks",
                                "description": "The docker networks to join",
                                "schema": {
                                    "type": "list",
                                    "show_if": [
                                        [
                                            "host_network",
                                            "=",
                                            false
                                        ]
                                    ],
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "network",
                                            "label": "Network",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "description": "The name of the network to join.</br>\nThe network must already exist.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "default": "",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "containers",
                                                        "label": "Containers",
                                                        "description": "The containers to add to this network.",
                                                        "schema": {
                                                            "type": "list",
                                                            "items": [
                                                                {
                                                                    "variable": "container",
                                                                    "label": "Container",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "attrs": [
                                                                            {
                                                                                "variable": "name",
                                                                                "label": "Container Name",
                                                                                "schema": {
                                                                                    "type": "string",
                                                                                    "required": true,
                                                                                    "enum": [
                                                                                        {
                                                                                            "value": "recyclarr",
                                                                                            "description": "recyclarr"
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            },
                                                                            {
                                                                                "variable": "config",
                                                                                "label": "Container Network Configuration",
                                                                                "schema": {
                                                                                    "type": "dict",
                                                                                    "attrs": [
                                                                                        {
                                                                                            "variable": "aliases",
                                                                                            "label": "Aliases (Optional)",
                                                                                            "description": "The network aliases to use for this container on this network.",
                                                                                            "schema": {
                                                                                                "type": "list",
                                                                                                "default": [],
                                                                                                "items": [
                                                                                                    {
                                                                                                        "variable": "alias",
                                                                                                        "label": "Alias",
                                                                                                        "schema": {
                                                                                                            "type": "string"
                                                                                                        }
                                                                                                    }
                                                                                                ]
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "interface_name",
                                                                                            "label": "Interface Name (Optional)",
                                                                                            "description": "The network interface name to use for this network",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "mac_address",
                                                                                            "label": "MAC Address (Optional)",
                                                                                            "description": "The MAC address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "ipv4_address",
                                                                                            "label": "IPv4 Address (Optional)",
                                                                                            "description": "The IPv4 address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "ipv6_address",
                                                                                            "label": "IPv6 Address (Optional)",
                                                                                            "description": "The IPv6 address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "gw_priority",
                                                                                            "label": "Gateway Priority (Optional)",
                                                                                            "description": "Indicates the priority of the gateway for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "int",
                                                                                                "null": true
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "priority",
                                                                                            "label": "Priority (Optional)",
                                                                                            "description": "Indicates in which order Compose connects the service's containers to its networks.",
                                                                                            "schema": {
                                                                                                "type": "int",
                                                                                                "null": true
                                                                                            }
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            }
                                                                        ]
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "host_network",
                                "label": "Host Network",
                                "description": "Bind to the host network. It's recommended to keep this disabled.\n",
                                "schema": {
                                    "type": "boolean",
                                    "default": false
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "storage",
                    "label": "",
                    "group": "Storage Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "config",
                                "label": "Recyclarr Config Storage",
                                "description": "The path to store Recyclarr Config.",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "type",
                                            "label": "Type",
                                            "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
                                            "schema": {
                                                "type": "string",
                                                "required": true,
                                                "default": "ix_volume",
                                                "enum": [
                                                    {
                                                        "value": "host_path",
                                                        "description": "Host Path (Path that already exists on the system)"
                                                    },
                                                    {
                                                        "value": "ix_volume",
                                                        "description": "ixVolume (Dataset created automatically by the system)"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "ix_volume_config",
                                            "label": "ixVolume Configuration",
                                            "description": "The configuration for the ixVolume dataset.",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "ix_volume"
                                                    ]
                                                ],
                                                "$ref": [
                                                    "normalize/ix_volume"
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "dataset_name",
                                                        "label": "Dataset Name",
                                                        "description": "The name of the dataset to use for storage.",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "hidden": true,
                                                            "default": "config"
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl_entries",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": []
                                                        }
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "host_path_config",
                                            "label": "Host Path Configuration",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "host_path"
                                                    ]
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": [],
                                                            "$ref": [
                                                                "normalize/acl"
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "path",
                                                        "label": "Host Path",
                                                        "description": "The host path to use for storage.",
                                                        "schema": {
                                                            "type": "hostpath",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    false
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "additional_storage",
                                "label": "Additional Storage",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "storageEntry",
                                            "label": "Storage Entry",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "type",
                                                        "label": "Type",
                                                        "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.</br>\nNFS Share: Is a NFS share that is mounted to as a volume.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "default": "ix_volume",
                                                            "enum": [
                                                                {
                                                                    "value": "host_path",
                                                                    "description": "Host Path (Path that already exists on the system)"
                                                                },
                                                                {
                                                                    "value": "ix_volume",
                                                                    "description": "ixVolume (Dataset created automatically by the system)"
                                                                },
                                                                {
                                                                    "value": "cifs",
                                                                    "description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
                                                                },
                                                                {
                                                                    "value": "nfs",
                                                                    "description": "NFS Share (Mounts a volume to a NFS share)"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "read_only",
                                                        "label": "Read Only",
                                                        "description": "Mount the volume as read only.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "mount_path",
                                                        "label": "Mount Path",
                                                        "description": "The path inside the container to mount the storage.",
                                                        "schema": {
                                                            "type": "path",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "host_path_config",
                                                        "label": "Host Path Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "host_path"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Host Path",
                                                                    "description": "The host path to use for storage.",
                                                                    "schema": {
                                                                        "type": "hostpath",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                false
                                                                            ]
                                                                        ],
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "ix_volume_config",
                                                        "label": "ixVolume Configuration",
                                                        "description": "The configuration for the ixVolume dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "ix_volume"
                                                                ]
                                                            ],
                                                            "$ref": [
                                                                "normalize/ix_volume"
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "dataset_name",
                                                                    "label": "Dataset Name",
                                                                    "description": "The name of the dataset to use for storage.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "default": "storage_entry"
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl_entries",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "cifs_config",
                                                        "label": "SMB Configuration",
                                                        "description": "The configuration for the SMB dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "cifs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "username",
                                                                    "label": "Username",
                                                                    "description": "The username to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "password",
                                                                    "label": "Password",
                                                                    "description": "The password to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "private": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "domain",
                                                                    "label": "Domain",
                                                                    "description": "The domain to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string"
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "nfs_config",
                                                        "label": "NFS Configuration",
                                                        "description": "The configuration for the NFS dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "nfs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "labels",
                    "label": "",
                    "group": "Labels Configuration",
                    "schema": {
                        "type": "list",
                        "default": [],
                        "items": [
                            {
                                "variable": "label",
                                "label": "Label",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "key",
                                            "label": "Key",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "value",
                                            "label": "Value",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "containers",
                                            "label": "Containers",
                                            "description": "Containers where the label should be applied",
                                            "schema": {
                                                "type": "list",
                                                "items": [
                                                    {
                                                        "variable": "container",
                                                        "label": "Container",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "enum": [
                                                                {
                                                                    "value": "recyclarr",
                                                                    "description": "recyclarr"
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "resources",
                    "label": "",
                    "group": "Resources Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "limits",
                                "label": "Limits",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "cpus",
                                            "label": "CPUs",
                                            "description": "CPUs limit for Recyclarr.",
                                            "schema": {
                                                "type": "int",
                                                "default": 2,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "memory",
                                            "label": "Memory (in MB)",
                                            "description": "Memory limit for Recyclarr.",
                                            "schema": {
                                                "type": "int",
                                                "default": 4096,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        },
        "readme": "<h1>Recyclarr</h1> <p><a href=\"https://github.com/recyclarr/recyclarr\">Recyclarr</a> synchronizes recommended settings from the TRaSH guides to your Sonarr/Radarr instances.</p>",
        "changelog": null,
        "chart_metadata": {
            "app_version": "8.5.1",
            "capabilities": [],
            "categories": [
                "media"
            ],
            "changelog_url": "https://github.com/recyclarr/recyclarr/blob/master/CHANGELOG.md",
            "date_added": "2024-09-10",
            "description": "Recyclarr synchronizes recommended settings from the TRaSH guides to your Sonarr/Radarr instances.",
            "home": "https://recyclarr.dev",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/recyclarr/icons/icon.png",
            "keywords": [
                "sync",
                "sonarr",
                "radarr"
            ],
            "lib_version": "2.3.1",
            "lib_version_hash": "561017357f22eafbedca2a97f747325cb83149fe1b5f765a2fbda71ab77d96ed",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "recyclarr",
            "run_as_context": [
                {
                    "description": "Container [recyclarr] can run as any non-root user and group.",
                    "gid": 568,
                    "group_name": "Host group is [apps]",
                    "uid": 568,
                    "user_name": "Host user is [apps]"
                }
            ],
            "screenshots": [],
            "sources": [
                "https://recyclarr.dev",
                "https://github.com/recyclarr/recyclarr/tree/recyclarr"
            ],
            "title": "Recyclarr",
            "train": "community",
            "version": "1.3.12"
        }
    }
}

Resources

Read full post gdoc_arrow_right_alt
11 minutes to read apps

Redis

← Catalog
1,000 active deployments icon
Redis
Get Started with Apps!
Requires TrueNAS: 24.10.2.2 or newer
App Version: 8.6.2
Keywords: cache
Train: Community
Home Page: https://redis.io/
Redis Details
Added: 2024-09-11
Last Updated: 2026-04-03

Redis. The open source, in-memory data store used by millions of developers as a database, cache, streaming engine, and message broker.

Run as Context
  • Container [redis] can run as any non-root user and group.
    Group: 568 / Host group is [apps]
    User: 568 / Host user is [apps]

App Metadata (Raw File)
{
    "1.3.5": {
        "healthy": true,
        "supported": true,
        "healthy_error": null,
        "location": "/__w/apps/apps/trains/community/redis/1.3.5",
        "last_update": "2026-04-03 12:46:56",
        "required_features": [],
        "human_version": "8.6.2_1.3.5",
        "version": "1.3.5",
        "app_metadata": {
            "annotations": {
                "min_scale_version": "24.10.2.2"
            },
            "app_version": "8.6.2",
            "capabilities": [],
            "categories": [
                "database"
            ],
            "date_added": "2024-09-11",
            "description": "Redis. The open source, in-memory data store used by millions of developers as a database, cache, streaming engine, and message broker.",
            "home": "https://redis.io/",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/redis/icons/icon.png",
            "keywords": [
                "cache"
            ],
            "lib_version": "2.3.1",
            "lib_version_hash": "561017357f22eafbedca2a97f747325cb83149fe1b5f765a2fbda71ab77d96ed",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "redis",
            "run_as_context": [
                {
                    "description": "Container [redis] can run as any non-root user and group.",
                    "gid": 568,
                    "group_name": "Host group is [apps]",
                    "uid": 568,
                    "user_name": "Host user is [apps]"
                }
            ],
            "screenshots": [],
            "sources": [
                "https://hub.docker.com/_/redis",
                "https://redis.io/"
            ],
            "title": "Redis",
            "train": "community",
            "version": "1.3.5"
        },
        "schema": {
            "groups": [
                {
                    "name": "Redis Configuration",
                    "description": "Configure Redis"
                },
                {
                    "name": "User and Group Configuration",
                    "description": "Configure User and Group for Redis"
                },
                {
                    "name": "Network Configuration",
                    "description": "Configure Network for Redis"
                },
                {
                    "name": "Storage Configuration",
                    "description": "Configure Storage for Redis"
                },
                {
                    "name": "Labels Configuration",
                    "description": "Configure Labels for Redis"
                },
                {
                    "name": "Resources Configuration",
                    "description": "Configure Resources for Redis"
                }
            ],
            "questions": [
                {
                    "variable": "redis",
                    "label": "",
                    "group": "Redis Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "allow_empty_password",
                                "label": "Allow Empty Password",
                                "description": "Allow empty password for Redis.",
                                "schema": {
                                    "type": "boolean",
                                    "default": false
                                }
                            },
                            {
                                "variable": "password",
                                "label": "Password",
                                "description": "The password for Redis.",
                                "schema": {
                                    "type": "string",
                                    "default": "",
                                    "private": true,
                                    "required": true,
                                    "show_if": [
                                        [
                                            "allow_empty_password",
                                            "=",
                                            false
                                        ]
                                    ],
                                    "valid_chars": "^((?!@).)*$",
                                    "valid_chars_error": "Character @ is not allowed in password"
                                }
                            },
                            {
                                "variable": "additional_envs",
                                "label": "Additional Environment Variables",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "env",
                                            "label": "Environment Variable",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "value",
                                                        "label": "Value",
                                                        "schema": {
                                                            "type": "string"
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "run_as",
                    "label": "",
                    "group": "User and Group Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "user",
                                "label": "User ID",
                                "description": "The user id that Redis files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            },
                            {
                                "variable": "group",
                                "label": "Group ID",
                                "description": "The group id that Redis files will be owned by.",
                                "schema": {
                                    "type": "int",
                                    "min": 568,
                                    "default": 568,
                                    "required": true
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "network",
                    "label": "",
                    "group": "Network Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "tcp_port",
                                "label": "TCP Port",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "bind_mode",
                                            "label": "Port Bind Mode",
                                            "description": "The port bind mode.</br>\n- Publish: The port will be published on the host for external access.</br>\n- Expose: The port will be exposed for inter-container communication.</br>\n- None: The port will not be exposed or published.</br>\nNote: If the Dockerfile defines an EXPOSE directive,\nthe port will still be exposed for inter-container communication regardless of this setting.\n",
                                            "schema": {
                                                "type": "string",
                                                "default": "published",
                                                "enum": [
                                                    {
                                                        "value": "published",
                                                        "description": "Publish port on the host for external access"
                                                    },
                                                    {
                                                        "value": "exposed",
                                                        "description": "Expose port for inter-container communication"
                                                    },
                                                    {
                                                        "value": "",
                                                        "description": "None"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "port_number",
                                            "label": "Port Number",
                                            "schema": {
                                                "type": "int",
                                                "default": 30059,
                                                "min": 1,
                                                "max": 65535,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "host_ips",
                                            "label": "Host IPs",
                                            "description": "IPs on the host to bind this port",
                                            "schema": {
                                                "type": "list",
                                                "show_if": [
                                                    [
                                                        "bind_mode",
                                                        "=",
                                                        "published"
                                                    ]
                                                ],
                                                "default": [],
                                                "items": [
                                                    {
                                                        "variable": "host_ip",
                                                        "label": "Host IP",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "$ref": [
                                                                "definitions/node_bind_ip"
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "networks",
                                "label": "Networks",
                                "description": "The docker networks to join",
                                "schema": {
                                    "type": "list",
                                    "show_if": [
                                        [
                                            "host_network",
                                            "=",
                                            false
                                        ]
                                    ],
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "network",
                                            "label": "Network",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "name",
                                                        "label": "Name",
                                                        "description": "The name of the network to join.</br>\nThe network must already exist.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "default": "",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "containers",
                                                        "label": "Containers",
                                                        "description": "The containers to add to this network.",
                                                        "schema": {
                                                            "type": "list",
                                                            "items": [
                                                                {
                                                                    "variable": "container",
                                                                    "label": "Container",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "attrs": [
                                                                            {
                                                                                "variable": "name",
                                                                                "label": "Container Name",
                                                                                "schema": {
                                                                                    "type": "string",
                                                                                    "required": true,
                                                                                    "enum": [
                                                                                        {
                                                                                            "value": "redis",
                                                                                            "description": "redis"
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            },
                                                                            {
                                                                                "variable": "config",
                                                                                "label": "Container Network Configuration",
                                                                                "schema": {
                                                                                    "type": "dict",
                                                                                    "attrs": [
                                                                                        {
                                                                                            "variable": "aliases",
                                                                                            "label": "Aliases (Optional)",
                                                                                            "description": "The network aliases to use for this container on this network.",
                                                                                            "schema": {
                                                                                                "type": "list",
                                                                                                "default": [],
                                                                                                "items": [
                                                                                                    {
                                                                                                        "variable": "alias",
                                                                                                        "label": "Alias",
                                                                                                        "schema": {
                                                                                                            "type": "string"
                                                                                                        }
                                                                                                    }
                                                                                                ]
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "interface_name",
                                                                                            "label": "Interface Name (Optional)",
                                                                                            "description": "The network interface name to use for this network",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "mac_address",
                                                                                            "label": "MAC Address (Optional)",
                                                                                            "description": "The MAC address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "ipv4_address",
                                                                                            "label": "IPv4 Address (Optional)",
                                                                                            "description": "The IPv4 address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "ipv6_address",
                                                                                            "label": "IPv6 Address (Optional)",
                                                                                            "description": "The IPv6 address to use for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "string"
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "gw_priority",
                                                                                            "label": "Gateway Priority (Optional)",
                                                                                            "description": "Indicates the priority of the gateway for this network interface.",
                                                                                            "schema": {
                                                                                                "type": "int",
                                                                                                "null": true
                                                                                            }
                                                                                        },
                                                                                        {
                                                                                            "variable": "priority",
                                                                                            "label": "Priority (Optional)",
                                                                                            "description": "Indicates in which order Compose connects the service's containers to its networks.",
                                                                                            "schema": {
                                                                                                "type": "int",
                                                                                                "null": true
                                                                                            }
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            }
                                                                        ]
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "host_network",
                                "label": "Host Network",
                                "description": "Bind to the host network. It's recommended to keep this disabled.\n",
                                "schema": {
                                    "type": "boolean",
                                    "default": false
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "storage",
                    "label": "",
                    "group": "Storage Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "data",
                                "label": "Redis Data Storage",
                                "description": "The path to store Redis Data.",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "type",
                                            "label": "Type",
                                            "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
                                            "schema": {
                                                "type": "string",
                                                "required": true,
                                                "default": "ix_volume",
                                                "enum": [
                                                    {
                                                        "value": "host_path",
                                                        "description": "Host Path (Path that already exists on the system)"
                                                    },
                                                    {
                                                        "value": "ix_volume",
                                                        "description": "ixVolume (Dataset created automatically by the system)"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "ix_volume_config",
                                            "label": "ixVolume Configuration",
                                            "description": "The configuration for the ixVolume dataset.",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "ix_volume"
                                                    ]
                                                ],
                                                "$ref": [
                                                    "normalize/ix_volume"
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "dataset_name",
                                                        "label": "Dataset Name",
                                                        "description": "The name of the dataset to use for storage.",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "hidden": true,
                                                            "default": "data"
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl_entries",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": []
                                                        }
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "host_path_config",
                                            "label": "Host Path Configuration",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "host_path"
                                                    ]
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": [],
                                                            "$ref": [
                                                                "normalize/acl"
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "path",
                                                        "label": "Host Path",
                                                        "description": "The host path to use for storage.",
                                                        "schema": {
                                                            "type": "hostpath",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    false
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "additional_storage",
                                "label": "Additional Storage",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "storageEntry",
                                            "label": "Storage Entry",
                                            "schema": {
                                                "type": "dict",
                                                "attrs": [
                                                    {
                                                        "variable": "type",
                                                        "label": "Type",
                                                        "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.</br>\nNFS Share: Is a NFS share that is mounted to as a volume.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "default": "ix_volume",
                                                            "enum": [
                                                                {
                                                                    "value": "host_path",
                                                                    "description": "Host Path (Path that already exists on the system)"
                                                                },
                                                                {
                                                                    "value": "ix_volume",
                                                                    "description": "ixVolume (Dataset created automatically by the system)"
                                                                },
                                                                {
                                                                    "value": "cifs",
                                                                    "description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
                                                                },
                                                                {
                                                                    "value": "nfs",
                                                                    "description": "NFS Share (Mounts a volume to a NFS share)"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "read_only",
                                                        "label": "Read Only",
                                                        "description": "Mount the volume as read only.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "mount_path",
                                                        "label": "Mount Path",
                                                        "description": "The path inside the container to mount the storage.",
                                                        "schema": {
                                                            "type": "path",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "host_path_config",
                                                        "label": "Host Path Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "host_path"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Host Path",
                                                                    "description": "The host path to use for storage.",
                                                                    "schema": {
                                                                        "type": "hostpath",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                false
                                                                            ]
                                                                        ],
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "ix_volume_config",
                                                        "label": "ixVolume Configuration",
                                                        "description": "The configuration for the ixVolume dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "ix_volume"
                                                                ]
                                                            ],
                                                            "$ref": [
                                                                "normalize/ix_volume"
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "acl_enable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the storage.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "dataset_name",
                                                                    "label": "Dataset Name",
                                                                    "description": "The name of the dataset to use for storage.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "default": "storage_entry"
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl_entries",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "acl_enable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "cifs_config",
                                                        "label": "SMB Configuration",
                                                        "description": "The configuration for the SMB dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "cifs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "username",
                                                                    "label": "Username",
                                                                    "description": "The username to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "password",
                                                                    "label": "Password",
                                                                    "description": "The password to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "private": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "domain",
                                                                    "label": "Domain",
                                                                    "description": "The domain to use for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string"
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "nfs_config",
                                                        "label": "NFS Configuration",
                                                        "description": "The configuration for the NFS dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "nfs"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "path",
                                                                    "label": "Path",
                                                                    "description": "The path to mount the NFS share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "labels",
                    "label": "",
                    "group": "Labels Configuration",
                    "schema": {
                        "type": "list",
                        "default": [],
                        "items": [
                            {
                                "variable": "label",
                                "label": "Label",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "key",
                                            "label": "Key",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "value",
                                            "label": "Value",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "containers",
                                            "label": "Containers",
                                            "description": "Containers where the label should be applied",
                                            "schema": {
                                                "type": "list",
                                                "items": [
                                                    {
                                                        "variable": "container",
                                                        "label": "Container",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "enum": [
                                                                {
                                                                    "value": "redis",
                                                                    "description": "redis"
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "resources",
                    "label": "",
                    "group": "Resources Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "limits",
                                "label": "Limits",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "cpus",
                                            "label": "CPUs",
                                            "description": "CPUs limit for Redis.",
                                            "schema": {
                                                "type": "int",
                                                "default": 2,
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "memory",
                                            "label": "Memory (in MB)",
                                            "description": "Memory limit for Redis.",
                                            "schema": {
                                                "type": "int",
                                                "default": 4096,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        },
        "readme": "<h1>Redis</h1> <p><a href=\"https://redis.io/\">Redis</a>. The open source, in-memory data store used by millions of developers as a database, cache, streaming engine, and message broker.</p>",
        "changelog": null,
        "chart_metadata": {
            "annotations": {
                "min_scale_version": "24.10.2.2"
            },
            "app_version": "8.6.2",
            "capabilities": [],
            "categories": [
                "database"
            ],
            "date_added": "2024-09-11",
            "description": "Redis. The open source, in-memory data store used by millions of developers as a database, cache, streaming engine, and message broker.",
            "home": "https://redis.io/",
            "host_mounts": [],
            "icon": "https://media.sys.truenas.net/apps/redis/icons/icon.png",
            "keywords": [
                "cache"
            ],
            "lib_version": "2.3.1",
            "lib_version_hash": "561017357f22eafbedca2a97f747325cb83149fe1b5f765a2fbda71ab77d96ed",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "redis",
            "run_as_context": [
                {
                    "description": "Container [redis] can run as any non-root user and group.",
                    "gid": 568,
                    "group_name": "Host group is [apps]",
                    "uid": 568,
                    "user_name": "Host user is [apps]"
                }
            ],
            "screenshots": [],
            "sources": [
                "https://hub.docker.com/_/redis",
                "https://redis.io/"
            ],
            "title": "Redis",
            "train": "community",
            "version": "1.3.5"
        }
    }
}

Resources

Read full post gdoc_arrow_right_alt
12 minutes to read apps

Remote Assist

← Catalog
Remote Assist
Get Started with Apps!
App Version: v1.94.2
Keywords: remote assistance, vpn
Train: Enterprise
Home Page: https://truenas.com
Remote Assist Details
Added: 2025-01-27
Last Updated: 2026-02-20

Invite the TrueNAS team to remotely assist with your TrueNAS system.

Run as Context
  • Container [remote-assist] runs as root user and group.
    Group: 0 / Host group is [root]
    User: 0 / Host user is [root]

Host Mounts
  • /dev/net/tun : Network device

Security Capabilities
  • Remote Assist is able to change file ownership arbitrarily
  • Remote Assist is able to bypass file permission checks
  • Remote Assist is able to bypass permission checks for file operations
  • Remote Assist is able to perform network administration tasks
  • Remote Assist is able to use raw and packet sockets
  • Remote Assist is able to load and unload kernel modules

App Metadata (Raw File)
{
    "1.0.41": {
        "healthy": true,
        "supported": true,
        "healthy_error": null,
        "location": "/__w/apps/apps/trains/enterprise/ix-remote-assist/1.0.41",
        "last_update": "2026-02-20 17:02:53",
        "required_features": [],
        "human_version": "v1.94.2_1.0.41",
        "version": "1.0.41",
        "app_metadata": {
            "annotations": {
                "disallow_multiple_instances": true
            },
            "app_version": "v1.94.2",
            "capabilities": [
                {
                    "description": "Remote Assist is able to change file ownership arbitrarily",
                    "name": "CHOWN"
                },
                {
                    "description": "Remote Assist is able to bypass file permission checks",
                    "name": "DAC_OVERRIDE"
                },
                {
                    "description": "Remote Assist is able to bypass permission checks for file operations",
                    "name": "FOWNER"
                },
                {
                    "description": "Remote Assist is able to perform network administration tasks",
                    "name": "NET_ADMIN"
                },
                {
                    "description": "Remote Assist is able to use raw and packet sockets",
                    "name": "NET_RAW"
                },
                {
                    "description": "Remote Assist is able to load and unload kernel modules",
                    "name": "SYS_MODULE"
                }
            ],
            "categories": [
                "networking"
            ],
            "date_added": "2025-01-27",
            "description": "Invite the TrueNAS team to remotely assist with your TrueNAS system.",
            "home": "https://truenas.com",
            "host_mounts": [
                {
                    "description": "Network device",
                    "host_path": "/dev/net/tun"
                }
            ],
            "icon": "https://media.sys.truenas.net/apps/ix-app/icons/icon.webp",
            "keywords": [
                "remote assistance",
                "vpn"
            ],
            "lib_version": "2.1.77",
            "lib_version_hash": "1837f8e69ae1adc313330c3b1c2615e9b4d03c5459d657a5898bae78090f8195",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "ix-remote-assist",
            "run_as_context": [
                {
                    "description": "Container [remote-assist] runs as root user and group.",
                    "gid": 0,
                    "group_name": "Host group is [root]",
                    "uid": 0,
                    "user_name": "Host user is [root]"
                }
            ],
            "screenshots": [],
            "sources": [
                "https://truenas.com/",
                "https://hub.docker.com/r/tailscale/tailscale"
            ],
            "title": "Remote Assist",
            "train": "enterprise",
            "version": "1.0.41"
        },
        "schema": {
            "groups": [
                {
                    "name": "Configuration",
                    "description": "Remote Assist is used by iX Support for Enterprise troubleshooting"
                },
                {
                    "name": "Storage Configuration",
                    "description": "Configure Storage for Tailscale"
                }
            ],
            "questions": [
                {
                    "variable": "remote_assist",
                    "label": "",
                    "group": "Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "hostname",
                                "label": "System Identifier",
                                "description": "Identifier for this System.</br>\nOne will be given to you by iX Support.\n",
                                "schema": {
                                    "type": "string",
                                    "default": "truenas-scale",
                                    "valid_chars": "^[a-z0-9-]+$",
                                    "valid_chars_error": "Only lowercase letters, numbers, and hyphens are allowed.\n",
                                    "required": true
                                }
                            },
                            {
                                "variable": "auth_key",
                                "label": "Auth Key",
                                "description": "The auth key for Remote Assistance.</br>\nPlease enter the key as provided by iX support.</br>\n",
                                "schema": {
                                    "type": "string",
                                    "default": "",
                                    "required": true,
                                    "private": true
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "storage",
                    "label": "",
                    "group": "Storage Configuration",
                    "schema": {
                        "type": "dict",
                        "hidden": true,
                        "attrs": [
                            {
                                "variable": "state",
                                "label": "Tailscale State Storage",
                                "description": "The path to store Tailscale State.",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "type",
                                            "label": "Type",
                                            "description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
                                            "schema": {
                                                "type": "string",
                                                "required": true,
                                                "default": "ix_volume",
                                                "enum": [
                                                    {
                                                        "value": "ix_volume",
                                                        "description": "ixVolume (Dataset created automatically by the system)"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "ix_volume_config",
                                            "label": "ixVolume Configuration",
                                            "description": "The configuration for the ixVolume dataset.",
                                            "schema": {
                                                "type": "dict",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "ix_volume"
                                                    ]
                                                ],
                                                "$ref": [
                                                    "normalize/ix_volume"
                                                ],
                                                "attrs": [
                                                    {
                                                        "variable": "acl_enable",
                                                        "label": "Enable ACL",
                                                        "description": "Enable ACL for the storage.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "dataset_name",
                                                        "label": "Dataset Name",
                                                        "description": "The name of the dataset to use for storage.",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "hidden": true,
                                                            "default": "state"
                                                        }
                                                    },
                                                    {
                                                        "variable": "acl_entries",
                                                        "label": "ACL Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "acl_enable",
                                                                    "=",
                                                                    true
                                                                ]
                                                            ],
                                                            "attrs": []
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        },
        "readme": "<h1>Remote Assist</h1> <p><a href=\"https://truenas.com\">Remote Assist</a> iX support remote assistance for Enterprise Systems</p>",
        "changelog": null,
        "chart_metadata": {
            "annotations": {
                "disallow_multiple_instances": true
            },
            "app_version": "v1.94.2",
            "capabilities": [
                {
                    "description": "Remote Assist is able to change file ownership arbitrarily",
                    "name": "CHOWN"
                },
                {
                    "description": "Remote Assist is able to bypass file permission checks",
                    "name": "DAC_OVERRIDE"
                },
                {
                    "description": "Remote Assist is able to bypass permission checks for file operations",
                    "name": "FOWNER"
                },
                {
                    "description": "Remote Assist is able to perform network administration tasks",
                    "name": "NET_ADMIN"
                },
                {
                    "description": "Remote Assist is able to use raw and packet sockets",
                    "name": "NET_RAW"
                },
                {
                    "description": "Remote Assist is able to load and unload kernel modules",
                    "name": "SYS_MODULE"
                }
            ],
            "categories": [
                "networking"
            ],
            "date_added": "2025-01-27",
            "description": "Invite the TrueNAS team to remotely assist with your TrueNAS system.",
            "home": "https://truenas.com",
            "host_mounts": [
                {
                    "description": "Network device",
                    "host_path": "/dev/net/tun"
                }
            ],
            "icon": "https://media.sys.truenas.net/apps/ix-app/icons/icon.webp",
            "keywords": [
                "remote assistance",
                "vpn"
            ],
            "lib_version": "2.1.77",
            "lib_version_hash": "1837f8e69ae1adc313330c3b1c2615e9b4d03c5459d657a5898bae78090f8195",
            "maintainers": [
                {
                    "email": "dev@truenas.com",
                    "name": "truenas",
                    "url": "https://www.truenas.com/"
                }
            ],
            "name": "ix-remote-assist",
            "run_as_context": [
                {
                    "description": "Container [remote-assist] runs as root user and group.",
                    "gid": 0,
                    "group_name": "Host group is [root]",
                    "uid": 0,
                    "user_name": "Host user is [root]"
                }
            ],
            "screenshots": [],
            "sources": [
                "https://truenas.com/",
                "https://hub.docker.com/r/tailscale/tailscale"
            ],
            "title": "Remote Assist",
            "train": "enterprise",
            "version": "1.0.41"
        }
    }
}

Resources

Read full post gdoc_arrow_right_alt

Remote Assist

← App Details

TrueNAS Enterprise icon TrueNAS Enterprise

TrueNAS Enterprise-licensed systems do not have applications available by default. To enable applications as part of the Enterprise license, consult with the TrueNAS Support team.

Official TrueNAS support for Enterprise apps falls under two tiers: Enterprise Deployment Support and Enterprise Application Support. Please review the App Support Definitions and consult with the TrueNAS Support Team for any further clarifications.

Read full post gdoc_arrow_right_alt

Romm

← Catalog
1,000 active deployments icon
RomM
Get Started with Apps!
App Version: 4.8.0 (Changelog)
Keywords: romm, rom, manager, emulator
Train: Community
Home Page: https://romm.app
RomM Details
Added: 2025-01-14
Last Updated: 2026-04-03

RomM allows you to scan, enrich, browse and play your game collection with a clean and responsive interface. With support for multiple platforms, various naming schemes, and custom tags, RomM is a must-have for anyone who plays on emulators.

Read full post gdoc_arrow_right_alt