ClamAV


Get Started with Apps!
Keywords: anti-virus, clamav
Train: Community
Home Page: https://www.clamav.net/
Added: 2024-08-01
Last Updated: 2025-04-23
ClamAV is an open source (GPLv2) anti-virus toolkit.
Run as Context- ClamAV runs as root user.
Group: 0 / root
User: 0 / root
Security Capabilities
- ClamAV is able to chown files.
- ClamAV is able bypass permission checks for it's sub-processes.
- ClamAV is able to bypass permission checks.
- ClamAV is able to set group ID for it's sub-processes.
- ClamAV is able to set user ID for it's sub-processes.
App Metadata (Raw File)
{
"1.2.17": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/clamav/1.2.17",
"last_update": "2025-04-23 17:40:39",
"required_features": [],
"human_version": "1.1.2-2_1.2.17",
"version": "1.2.17",
"app_metadata": {
"app_version": "1.1.2-2",
"capabilities": [
{
"description": "ClamAV is able to chown files.",
"name": "CHOWN"
},
{
"description": "ClamAV is able bypass permission checks for it's sub-processes.",
"name": "FOWNER"
},
{
"description": "ClamAV is able to bypass permission checks.",
"name": "DAC_OVERRIDE"
},
{
"description": "ClamAV is able to set group ID for it's sub-processes.",
"name": "SETGID"
},
{
"description": "ClamAV is able to set user ID for it's sub-processes.",
"name": "SETUID"
}
],
"categories": [
"security"
],
"changelog_url": "https://github.com/Cisco-Talos/clamav/releases",
"date_added": "2024-08-01",
"description": "ClamAV is an open source (GPLv2) anti-virus toolkit.",
"home": "https://www.clamav.net/",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/clamav/icons/icon.png",
"keywords": [
"anti-virus",
"clamav"
],
"lib_version": "2.1.16",
"lib_version_hash": "dac15686f882b9ce65b8549a3d5c0ed7bafe2df7a9028880d1a99b0ff4af1eff",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "clamav",
"run_as_context": [
{
"description": "ClamAV runs as root user.",
"gid": 0,
"group_name": "root",
"uid": 0,
"user_name": "root"
}
],
"screenshots": [],
"sources": [
"https://docs.clamav.net/",
"https://www.clamav.net/"
],
"title": "ClamAV",
"train": "community",
"version": "1.2.17"
},
"schema": {
"groups": [
{
"name": "ClamAV Configuration",
"description": "Configure ClamAV"
},
{
"name": "Network Configuration",
"description": "Configure Network for ClamAV"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for ClamAV"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for ClamAV"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for ClamAV"
}
],
"questions": [
{
"variable": "clamav",
"label": "",
"group": "ClamAV Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "disable_clamd",
"label": "Disable Clamd",
"description": "Disable Clamd",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "disable_freshclamd",
"label": "Disable Freshclamd",
"description": "Disable Freshclamd",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "disable_milterd",
"label": "Disable Milterd",
"description": "Disable Milterd",
"schema": {
"type": "boolean",
"default": true
}
},
{
"variable": "clamd_startup_timeout",
"label": "Clamd Startup Timeout",
"description": "Clamd Startup Timeout",
"schema": {
"type": "int",
"default": 1800,
"required": true
}
},
{
"variable": "freshclamd_checks",
"label": "Freshclamd Checks",
"description": "Freshclamd Checks",
"schema": {
"type": "int",
"default": 1,
"min": 1,
"max": 50,
"required": true
}
},
{
"variable": "additional_envs",
"label": "Additional Environment Variables",
"description": "Configure additional environment variables for ClamAV.",
"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": "network",
"label": "",
"group": "Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "clamd_port",
"label": "Clamd Port",
"description": "The port for Clamd",
"schema": {
"type": "int",
"default": 30005,
"show_if": [
[
"host_network",
"=",
false
]
],
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "milterd_port",
"label": "Milterd Port",
"description": "The port for Milterd",
"schema": {
"type": "int",
"default": 30006,
"show_if": [
[
"host_network",
"=",
false
]
],
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"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": "sigdb",
"label": "ClamAV Signature Database Storage",
"description": "The path to store ClamAV Signature Database.",
"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": "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,
"immutable": true,
"hidden": true,
"default": "sigdb"
}
},
{
"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": "scandir",
"label": "ClamAV Scan Directory Storage",
"description": "The path to store ClamAV Scan Directory.",
"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": "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,
"immutable": true,
"hidden": true,
"default": "scandir"
}
},
{
"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",
"description": "Additional storage for ClamAV.",
"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.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"immutable": true,
"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)"
}
]
}
},
{
"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,
"immutable": 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": "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": "clamav",
"description": "clamav"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"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 ClamAV.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for ClamAV.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>ClamAV</h1> <p><a href=\"https://www.clamav.net/\">ClamAV</a> - ClamAV\u00ae is an open-source antivirus engine for detecting trojans, viruses, malware & other malicious threats.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "1.1.2-2",
"capabilities": [
{
"description": "ClamAV is able to chown files.",
"name": "CHOWN"
},
{
"description": "ClamAV is able bypass permission checks for it's sub-processes.",
"name": "FOWNER"
},
{
"description": "ClamAV is able to bypass permission checks.",
"name": "DAC_OVERRIDE"
},
{
"description": "ClamAV is able to set group ID for it's sub-processes.",
"name": "SETGID"
},
{
"description": "ClamAV is able to set user ID for it's sub-processes.",
"name": "SETUID"
}
],
"categories": [
"security"
],
"changelog_url": "https://github.com/Cisco-Talos/clamav/releases",
"date_added": "2024-08-01",
"description": "ClamAV is an open source (GPLv2) anti-virus toolkit.",
"home": "https://www.clamav.net/",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/clamav/icons/icon.png",
"keywords": [
"anti-virus",
"clamav"
],
"lib_version": "2.1.16",
"lib_version_hash": "dac15686f882b9ce65b8549a3d5c0ed7bafe2df7a9028880d1a99b0ff4af1eff",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "clamav",
"run_as_context": [
{
"description": "ClamAV runs as root user.",
"gid": 0,
"group_name": "root",
"uid": 0,
"user_name": "root"
}
],
"screenshots": [],
"sources": [
"https://docs.clamav.net/",
"https://www.clamav.net/"
],
"title": "ClamAV",
"train": "community",
"version": "1.2.17"
}
}
}
Support, maintenance, and documentation for applications within the Community 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.
There currently aren’t any resources available for this application!
Please help the TrueNAS community create content or discuss this application in the TrueNAS Community forum.