truenas/community/readarr/app_versions.json

{
    "1.1.4": {
        "healthy": true,
        "supported": true,
        "healthy_error": null,
        "location": "/__w/charts/charts/community/readarr/1.1.4",
        "last_update": "2023-11-23 22:48:53",
        "required_features": [
            "normalize/ixVolume"
        ],
        "human_version": "0.3.10.2287_1.1.4",
        "version": "1.1.4",
        "chart_metadata": {
            "name": "readarr",
            "description": "Readarr is an ebook and audiobook collection manager for Usenet and BitTorrent users.",
            "annotations": {
                "title": "Readarr"
            },
            "type": "application",
            "version": "1.1.4",
            "apiVersion": "v2",
            "appVersion": "0.3.10.2287",
            "kubeVersion": ">=1.16.0-0",
            "maintainers": [
                {
                    "name": "truenas",
                    "url": "https://www.truenas.com/",
                    "email": "dev@ixsystems.com"
                }
            ],
            "dependencies": [
                {
                    "name": "common",
                    "repository": "file://../../../common",
                    "version": "1.2.3"
                }
            ],
            "home": "https://github.com/Readarr/Readarr",
            "icon": "https://media.sys.truenas.net/apps/readarr/icons/icon.png",
            "sources": [
                "https://github.com/onedr0p/containers/tree/main/apps/readarr",
                "https://github.com/truenas/charts/tree/master/library/ix-dev/community/readarr",
                "https://github.com/Readarr/Readarr"
            ],
            "keywords": [
                "media",
                "ebook",
                "audiobook"
            ]
        },
        "app_metadata": {
            "runAsContext": [
                {
                    "userName": "readarr",
                    "groupName": "readarr",
                    "gid": 568,
                    "uid": 568,
                    "description": "Readarr can run as any non-root user."
                }
            ],
            "capabilities": [],
            "hostMounts": []
        },
        "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": "Resources Configuration",
                    "description": "Configure Resources for Readarr"
                }
            ],
            "portals": {
                "web_portal": {
                    "protocols": [
                        "$kubernetes-resource_configmap_portal_protocol"
                    ],
                    "host": [
                        "$kubernetes-resource_configmap_portal_host"
                    ],
                    "ports": [
                        "$kubernetes-resource_configmap_portal_port"
                    ],
                    "path": "$kubernetes-resource_configmap_portal_path"
                }
            },
            "questions": [
                {
                    "variable": "readarrConfig",
                    "label": "",
                    "group": "Readarr Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "instanceName",
                                "label": "Instance Name",
                                "description": "The name of the Readarr instance.",
                                "schema": {
                                    "type": "string",
                                    "default": "Readarr",
                                    "required": true
                                }
                            },
                            {
                                "variable": "additionalEnvs",
                                "label": "Additional Environment Variables",
                                "description": "Configure additional environment variables for Readarr.",
                                "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",
                                                            "required": true
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "readarrRunAs",
                    "label": "",
                    "group": "User and Group Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "user",
                                "label": "User ID",
                                "description": "The user id that Readarr will run as.",
                                "schema": {
                                    "type": "int",
                                    "min": 2,
                                    "default": 568,
                                    "required": true
                                }
                            },
                            {
                                "variable": "group",
                                "label": "Group ID",
                                "description": "The group id that Readarr will run as.",
                                "schema": {
                                    "type": "int",
                                    "min": 2,
                                    "default": 568,
                                    "required": true
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "readarrNetwork",
                    "label": "",
                    "group": "Network Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "webPort",
                                "label": "Web Port",
                                "description": "The port for the Readarr Web UI.",
                                "schema": {
                                    "type": "int",
                                    "default": 30045,
                                    "min": 9000,
                                    "max": 65535,
                                    "required": true
                                }
                            },
                            {
                                "variable": "hostNetwork",
                                "label": "Host Network",
                                "description": "Bind to the host network. It's recommended to keep this disabled.</br>\n",
                                "schema": {
                                    "type": "boolean",
                                    "default": false
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "readarrStorage",
                    "label": "",
                    "group": "Storage Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "config",
                                "label": "Readarr Config Storage",
                                "description": "The path to store Readarr Configuration.",
                                "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,
                                                "immutable": true,
                                                "default": "ixVolume",
                                                "enum": [
                                                    {
                                                        "value": "hostPath",
                                                        "description": "Host Path (Path that already exists on the system)"
                                                    },
                                                    {
                                                        "value": "ixVolume",
                                                        "description": "ixVolume (Dataset created automatically by the system)"
                                                    }
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "datasetName",
                                            "label": "Dataset Name",
                                            "schema": {
                                                "type": "string",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "ixVolume"
                                                    ]
                                                ],
                                                "required": true,
                                                "hidden": true,
                                                "immutable": true,
                                                "default": "config",
                                                "$ref": [
                                                    "normalize/ixVolume"
                                                ]
                                            }
                                        },
                                        {
                                            "variable": "hostPath",
                                            "label": "Host Path",
                                            "schema": {
                                                "type": "hostpath",
                                                "show_if": [
                                                    [
                                                        "type",
                                                        "=",
                                                        "hostPath"
                                                    ]
                                                ],
                                                "immutable": true,
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "additionalStorages",
                                "label": "Additional Storage",
                                "description": "Additional storage for Readarr.",
                                "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 a persistent volume claim.\n",
                                                        "schema": {
                                                            "type": "string",
                                                            "required": true,
                                                            "default": "ixVolume",
                                                            "immutable": true,
                                                            "enum": [
                                                                {
                                                                    "value": "hostPath",
                                                                    "description": "Host Path (Path that already exists on the system)"
                                                                },
                                                                {
                                                                    "value": "ixVolume",
                                                                    "description": "ixVolume (Dataset created automatically by the system)"
                                                                },
                                                                {
                                                                    "value": "smb-pv-pvc",
                                                                    "description": "SMB Share (Mounts a persistent volume claim to a SMB share)"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "mountPath",
                                                        "label": "Mount Path",
                                                        "description": "The path inside the container to mount the storage.",
                                                        "schema": {
                                                            "type": "path",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "hostPath",
                                                        "label": "Host Path",
                                                        "description": "The host path to use for storage.",
                                                        "schema": {
                                                            "type": "hostpath",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "hostPath"
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "datasetName",
                                                        "label": "Dataset Name",
                                                        "description": "The name of the dataset to use for storage.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "ixVolume"
                                                                ]
                                                            ],
                                                            "required": true,
                                                            "immutable": true,
                                                            "default": "storage_entry",
                                                            "$ref": [
                                                                "normalize/ixVolume"
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "server",
                                                        "label": "Server",
                                                        "description": "The server for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "share",
                                                        "label": "Share",
                                                        "description": "The share name for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "domain",
                                                        "label": "Domain (Optional)",
                                                        "description": "The domain for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "username",
                                                        "label": "Username",
                                                        "description": "The username for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "password",
                                                        "label": "Password",
                                                        "description": "The password for the SMB share.",
                                                        "schema": {
                                                            "type": "string",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true,
                                                            "private": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "size",
                                                        "label": "Size (in Gi)",
                                                        "description": "The size of the volume quota.",
                                                        "schema": {
                                                            "type": "int",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "required": true,
                                                            "min": 1,
                                                            "default": 1
                                                        }
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "resources",
                    "group": "Resources Configuration",
                    "label": "",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "limits",
                                "label": "Limits",
                                "schema": {
                                    "type": "dict",
                                    "attrs": [
                                        {
                                            "variable": "cpu",
                                            "label": "CPU",
                                            "description": "CPU limit for Readarr.",
                                            "schema": {
                                                "type": "string",
                                                "max_length": 6,
                                                "valid_chars": "^(0\\.[1-9]|[1-9][0-9]*)(\\.[0-9]|m?)$",
                                                "valid_chars_error": "Valid CPU limit formats are</br>\n- Plain Integer - eg. 1</br>\n- Float - eg. 0.5</br>\n- Milicpu - eg. 500m\n",
                                                "default": "4000m",
                                                "required": true
                                            }
                                        },
                                        {
                                            "variable": "memory",
                                            "label": "Memory",
                                            "description": "Memory limit for Readarr.",
                                            "schema": {
                                                "type": "string",
                                                "max_length": 12,
                                                "valid_chars": "^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$",
                                                "valid_chars_error": "Valid Memory limit formats are</br>\n- Suffixed with E/P/T/G/M/K - eg. 1G</br>\n- Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>\n- Plain Integer in bytes - eg. 1024</br>\n- Exponent - eg. 134e6\n",
                                                "default": "8Gi",
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        },
        "app_readme": "<h1>Readarr</h1>\n<p><a href=\"https://github.com/Readarr/Readarr\">Readarr</a> is an ebook and audiobook collection manager for Usenet and BitTorrent users.</p>\n<blockquote>\n<p>When application is installed, a container will be launched with <strong>root</strong> privileges.\nThis is required in order to apply the correct permissions to the <code>Readarr</code> directories.\nAfterward, the <code>Readarr</code> container will run as a <strong>non</strong>-root user (Default: <code>568</code>).\nAll mounted storage(s) will be <code>chown</code>ed only if the parent directory does not match the configured user.</p>\n</blockquote>",
        "detailed_readme": "<h1>Readarr</h1>\n<p><a href=\"https://github.com/Readarr/Readarr\">Readarr</a> is an ebook and audiobook collection manager for Usenet and BitTorrent users.</p>\n<blockquote>\n<p>When application is installed, a container will be launched with <strong>root</strong> privileges.\nThis is required in order to apply the correct permissions to the <code>Readarr</code> directories.\nAfterward, the <code>Readarr</code> container will run as a <strong>non</strong>-root user (Default: <code>568</code>).\nAll mounted storage(s) will be <code>chown</code>ed only if the parent directory does not match the configured user.</p>\n</blockquote>",
        "changelog": null
    }
}