truenas/community/cloudflared/app_versions.json

{
    "1.2.28": {
        "healthy": true,
        "supported": false,
        "healthy_error": null,
        "location": "/__w/charts/charts/community/cloudflared/1.2.28",
        "last_update": "2025-03-06 08:26:26",
        "required_features": [
            "normalize/ixVolume",
            "normalize/acl"
        ],
        "human_version": "2025.2.1_1.2.28",
        "version": "1.2.28",
        "chart_metadata": {
            "name": "cloudflared",
            "description": "Cloudflared is a client for Cloudflare Tunnel, a daemon that exposes private services through the Cloudflare edge.",
            "annotations": {
                "title": "Cloudflared"
            },
            "type": "application",
            "version": "1.2.28",
            "apiVersion": "v2",
            "appVersion": "2025.2.1",
            "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.9"
                }
            ],
            "home": "https://github.com/cloudflare/cloudflared",
            "icon": "https://media.sys.truenas.net/apps/cloudflared/icons/icon.png",
            "sources": [
                "https://github.com/cloudflare/cloudflared",
                "https://github.com/truenas/charts/tree/master/library/ix-dev/community/cloudflared",
                "https://hub.docker.com/r/cloudflare/cloudflared"
            ],
            "keywords": [
                "network",
                "cloudflare",
                "tunnel"
            ]
        },
        "app_metadata": {
            "runAsContext": [
                {
                    "userName": "cloudflared",
                    "groupName": "cloudflared",
                    "gid": 568,
                    "uid": 568,
                    "description": "Cloudflared can run as any non-root user."
                }
            ],
            "capabilities": [],
            "hostMounts": []
        },
        "schema": {
            "groups": [
                {
                    "name": "Cloudflared Configuration",
                    "description": "Configure Cloudflared"
                },
                {
                    "name": "User and Group Configuration",
                    "description": "Configure User and Group for Cloudflared"
                },
                {
                    "name": "Network Configuration",
                    "description": "Configure Network for Cloudflared"
                },
                {
                    "name": "Storage Configuration",
                    "description": "Configure Storage for Cloudflared"
                },
                {
                    "name": "Resources Configuration",
                    "description": "Configure Resources for Cloudflared"
                }
            ],
            "questions": [
                {
                    "variable": "cloudflaredConfig",
                    "label": "",
                    "group": "Cloudflared Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "tunnelToken",
                                "label": "Tunnel Token",
                                "description": "The tunnel token to use for Cloudflared.",
                                "schema": {
                                    "type": "string",
                                    "default": "",
                                    "required": true,
                                    "private": true
                                }
                            },
                            {
                                "variable": "additionalArgs",
                                "label": "Additional Arguments",
                                "description": "Configure additional arguments for Cloudflared.</br>\nThose will be placed after the \"tunnel --no-autoupdate\" and before \"run\". </br>\nExample: </br>\ntunnel --no-autoupdate <my-arg> run </br>\nOne argument per line.\n",
                                "schema": {
                                    "type": "list",
                                    "default": [],
                                    "items": [
                                        {
                                            "variable": "arg",
                                            "label": "Argument",
                                            "schema": {
                                                "type": "string",
                                                "required": true
                                            }
                                        }
                                    ]
                                }
                            },
                            {
                                "variable": "additionalEnvs",
                                "label": "Additional Environment Variables",
                                "description": "Configure additional environment variables for Cloudflared.",
                                "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": "cloudflaredRunAs",
                    "label": "",
                    "group": "User and Group Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "user",
                                "label": "User ID",
                                "description": "The user id that Cloudflared will run as.",
                                "schema": {
                                    "type": "int",
                                    "min": 2,
                                    "default": 568,
                                    "required": true
                                }
                            },
                            {
                                "variable": "group",
                                "label": "Group ID",
                                "description": "The group id that Cloudflared will run as.",
                                "schema": {
                                    "type": "int",
                                    "min": 2,
                                    "default": 568,
                                    "required": true
                                }
                            }
                        ]
                    }
                },
                {
                    "variable": "cloudflaredNetwork",
                    "label": "",
                    "group": "Network Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "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": "cloudflaredStorage",
                    "label": "",
                    "group": "Storage Configuration",
                    "schema": {
                        "type": "dict",
                        "attrs": [
                            {
                                "variable": "additionalStorages",
                                "label": "Additional Storage",
                                "description": "Additional storage for Cloudflared.",
                                "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": "readOnly",
                                                        "label": "Read Only",
                                                        "description": "Mount the volume as read only.",
                                                        "schema": {
                                                            "type": "boolean",
                                                            "default": false
                                                        }
                                                    },
                                                    {
                                                        "variable": "mountPath",
                                                        "label": "Mount Path",
                                                        "description": "The path inside the container to mount the storage.",
                                                        "schema": {
                                                            "type": "path",
                                                            "required": true
                                                        }
                                                    },
                                                    {
                                                        "variable": "hostPathConfig",
                                                        "label": "Host Path Configuration",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "hostPath"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "aclEnable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the dataset.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "acl",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "aclEnable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [
                                                                            {
                                                                                "variable": "path",
                                                                                "label": "Host Path",
                                                                                "description": "Host Path to perform ACL",
                                                                                "schema": {
                                                                                    "type": "hostpath",
                                                                                    "required": true,
                                                                                    "empty": false
                                                                                }
                                                                            },
                                                                            {
                                                                                "variable": "entries",
                                                                                "label": "ACL Entries",
                                                                                "description": "ACL Entries",
                                                                                "schema": {
                                                                                    "type": "list",
                                                                                    "items": [
                                                                                        {
                                                                                            "variable": "aclEntry",
                                                                                            "label": "ACL Entry",
                                                                                            "schema": {
                                                                                                "type": "dict",
                                                                                                "attrs": [
                                                                                                    {
                                                                                                        "variable": "id_type",
                                                                                                        "label": "ID Type",
                                                                                                        "schema": {
                                                                                                            "type": "string",
                                                                                                            "enum": [
                                                                                                                {
                                                                                                                    "value": "USER",
                                                                                                                    "description": "Entry is for a USER"
                                                                                                                },
                                                                                                                {
                                                                                                                    "value": "GROUP",
                                                                                                                    "description": "Entry is for a GROUP"
                                                                                                                }
                                                                                                            ],
                                                                                                            "default": "USER"
                                                                                                        }
                                                                                                    },
                                                                                                    {
                                                                                                        "variable": "id",
                                                                                                        "label": "ID",
                                                                                                        "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
                                                                                                        "schema": {
                                                                                                            "type": "int",
                                                                                                            "required": true,
                                                                                                            "min": 0
                                                                                                        }
                                                                                                    },
                                                                                                    {
                                                                                                        "variable": "access",
                                                                                                        "label": "Access",
                                                                                                        "schema": {
                                                                                                            "type": "string",
                                                                                                            "enum": [
                                                                                                                {
                                                                                                                    "value": "READ",
                                                                                                                    "description": "Read Access"
                                                                                                                },
                                                                                                                {
                                                                                                                    "value": "MODIFY",
                                                                                                                    "description": "Modify Access"
                                                                                                                },
                                                                                                                {
                                                                                                                    "value": "FULL_CONTROL",
                                                                                                                    "description": "FULL_CONTROL Access"
                                                                                                                }
                                                                                                            ]
                                                                                                        }
                                                                                                    }
                                                                                                ]
                                                                                            }
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            },
                                                                            {
                                                                                "variable": "options",
                                                                                "label": "ACL Options",
                                                                                "schema": {
                                                                                    "type": "dict",
                                                                                    "attrs": [
                                                                                        {
                                                                                            "variable": "force",
                                                                                            "label": "Force Flag",
                                                                                            "description": "Enabling `Force` applies ACL even if the path has existing data",
                                                                                            "schema": {
                                                                                                "type": "boolean",
                                                                                                "default": false
                                                                                            }
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            }
                                                                        ],
                                                                        "$ref": [
                                                                            "normalize/acl"
                                                                        ]
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "hostPath",
                                                                    "label": "Host Path",
                                                                    "description": "The host path to use for storage.",
                                                                    "schema": {
                                                                        "type": "hostpath",
                                                                        "show_if": [
                                                                            [
                                                                                "aclEnable",
                                                                                "=",
                                                                                false
                                                                            ]
                                                                        ],
                                                                        "required": true
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "ixVolumeConfig",
                                                        "label": "ixVolume Configuration",
                                                        "description": "The configuration for the ixVolume dataset.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "ixVolume"
                                                                ]
                                                            ],
                                                            "$ref": [
                                                                "normalize/ixVolume"
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "aclEnable",
                                                                    "label": "Enable ACL",
                                                                    "description": "Enable ACL for the dataset.",
                                                                    "schema": {
                                                                        "type": "boolean",
                                                                        "default": false
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "datasetName",
                                                                    "label": "Dataset Name",
                                                                    "description": "The name of the dataset to use for storage.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "immutable": true,
                                                                        "default": "storage_entry"
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "aclEntries",
                                                                    "label": "ACL Configuration",
                                                                    "schema": {
                                                                        "type": "dict",
                                                                        "show_if": [
                                                                            [
                                                                                "aclEnable",
                                                                                "=",
                                                                                true
                                                                            ]
                                                                        ],
                                                                        "attrs": [
                                                                            {
                                                                                "variable": "path",
                                                                                "label": "Path",
                                                                                "description": "Path to perform ACL",
                                                                                "schema": {
                                                                                    "type": "string",
                                                                                    "hidden": true
                                                                                }
                                                                            },
                                                                            {
                                                                                "variable": "entries",
                                                                                "label": "ACL Entries",
                                                                                "description": "ACL Entries",
                                                                                "schema": {
                                                                                    "type": "list",
                                                                                    "items": [
                                                                                        {
                                                                                            "variable": "aclEntry",
                                                                                            "label": "ACL Entry",
                                                                                            "schema": {
                                                                                                "type": "dict",
                                                                                                "attrs": [
                                                                                                    {
                                                                                                        "variable": "id_type",
                                                                                                        "label": "ID Type",
                                                                                                        "schema": {
                                                                                                            "type": "string",
                                                                                                            "enum": [
                                                                                                                {
                                                                                                                    "value": "USER",
                                                                                                                    "description": "Entry is for a USER"
                                                                                                                },
                                                                                                                {
                                                                                                                    "value": "GROUP",
                                                                                                                    "description": "Entry is for a GROUP"
                                                                                                                }
                                                                                                            ],
                                                                                                            "default": "USER"
                                                                                                        }
                                                                                                    },
                                                                                                    {
                                                                                                        "variable": "id",
                                                                                                        "label": "ID",
                                                                                                        "description": "Make sure to check the ID value is correct and aligns with RunAs user context of the application",
                                                                                                        "schema": {
                                                                                                            "type": "int",
                                                                                                            "required": true,
                                                                                                            "min": 0
                                                                                                        }
                                                                                                    },
                                                                                                    {
                                                                                                        "variable": "access",
                                                                                                        "label": "Access",
                                                                                                        "schema": {
                                                                                                            "type": "string",
                                                                                                            "enum": [
                                                                                                                {
                                                                                                                    "value": "READ",
                                                                                                                    "description": "Read Access"
                                                                                                                },
                                                                                                                {
                                                                                                                    "value": "MODIFY",
                                                                                                                    "description": "Modify Access"
                                                                                                                },
                                                                                                                {
                                                                                                                    "value": "FULL_CONTROL",
                                                                                                                    "description": "FULL_CONTROL Access"
                                                                                                                }
                                                                                                            ]
                                                                                                        }
                                                                                                    }
                                                                                                ]
                                                                                            }
                                                                                        }
                                                                                    ]
                                                                                }
                                                                            }
                                                                        ]
                                                                    }
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "variable": "smbConfig",
                                                        "label": "SMB Share Configuration",
                                                        "description": "The configuration for the SMB Share.",
                                                        "schema": {
                                                            "type": "dict",
                                                            "show_if": [
                                                                [
                                                                    "type",
                                                                    "=",
                                                                    "smb-pv-pvc"
                                                                ]
                                                            ],
                                                            "attrs": [
                                                                {
                                                                    "variable": "server",
                                                                    "label": "Server",
                                                                    "description": "The server for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "share",
                                                                    "label": "Share",
                                                                    "description": "The share name for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "domain",
                                                                    "label": "Domain (Optional)",
                                                                    "description": "The domain for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string"
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "username",
                                                                    "label": "Username",
                                                                    "description": "The username for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "password",
                                                                    "label": "Password",
                                                                    "description": "The password for the SMB share.",
                                                                    "schema": {
                                                                        "type": "string",
                                                                        "required": true,
                                                                        "private": true
                                                                    }
                                                                },
                                                                {
                                                                    "variable": "size",
                                                                    "label": "Size (in Gi)",
                                                                    "description": "The size of the volume quota.",
                                                                    "schema": {
                                                                        "type": "int",
                                                                        "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 Cloudflared.",
                                            "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 Cloudflared.",
                                            "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>Cloudflared</h1>\n<p><a href=\"https://github.com/cloudflare/cloudflared\">Cloudflared</a> is a client for Cloudflare Tunnel, a daemon that exposes private services through the Cloudflare edge.</p>",
        "detailed_readme": "<h1>Cloudflared</h1>\n<p><a href=\"https://github.com/cloudflare/cloudflared\">Cloudflared</a> is a client for Cloudflare Tunnel, a daemon that exposes private services through the Cloudflare edge.</p>",
        "changelog": null
    }
}