Hexy Templates

ClamAV

ClamAV is an open source (GPLv2) anti-virus toolkit.

Not yet tested security Based on TrueNAS app v1.4.10 (ClamAV 1.5.4)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find ClamAV and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
clamav.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS clamav 1.4.10"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30005, 30006]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/clamav"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/clamav/sigdb",
18      "owner": {"user": "netdata", "group": "docker"},
19      "snapshot": {"id": "sigdb"}
20    },
21    {
22      "path": "$LOCATION(ApplicationsPerformance)/clamav/scandir",
23      "snapshot": {"id": "scandir"}
24    }
25  ],
26  "app_values": {
27    "storage": {
828      "sigdb": "$HOST_PATH($LOCATION(ApplicationsPerformance)/clamav/sigdb)",
929      "scandir": "$HOST_PATH($LOCATION(ApplicationsPerformance)/clamav/scandir)"
30    },
31    "network": {
1032      "clamd_port": {"bind_mode": "published", "port_number": 30005},
1133      "milterd_port": {"bind_mode": "published", "port_number": 30006}
34    },
1235    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
36  }
37}

What this script does

Hover or tap a box to see the lines it explains.

  1. Script format

    Tells HexOS this is a version 5 install script, so it knows how to read the rest.

    Line 2

  2. Script revision

    This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS clamav 1.4.10”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast). If one isn't set up yet, HexOS will ask you to pick a place for it.

    Line 8

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 9

  5. Permission to use your folders

    Allows the app to read and write files inside the storage locations listed above — and nowhere else.

    Line 10

  6. Network ports

    The app needs ports 30005 and 30006 to be free on your server. A port is like an apartment number for your server's address.

    Line 11

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › clamav, App storage (fast) › clamav › sigdb and App storage (fast) › clamav › scandir. Some folders are handed to a specific system user so the app is allowed to write to them. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–25

  8. Where the app's “sigdb” files is saved

    Where the app's “sigdb” files is saved on your server: App storage (fast) › clamav › sigdb.

    Line 28

  9. Where the app's “scandir” files is saved

    Where the app's “scandir” files is saved on your server: App storage (fast) › clamav › scandir.

    Line 29

  10. Clamd port: 30005

    Publishes the app's clamd port as 30005.

    Line 32

  11. Milterd port: 30006

    Publishes the app's milterd port as 30006.

    Line 33

  12. Resource limits

    Caps how much of your server the app can use: 2 CPU cores and 10% of your server's memory, but never more than 4 GB. This keeps one busy app from slowing everything else down.

    Line 35