Hexy Templates

LocalAI

The free, Open Source alternative to OpenAI, Claude and others. Self-hosted and local-first.

Not yet tested ai Based on TrueNAS app v1.1.42 (LocalAI v4.12.0)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find LocalAI and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
localai.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.1",
5    "changeLog": "Regenerated for TrueNAS localai 1.1.42"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30286]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/localai"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/localai/backends",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "backends"}
20    },
21    {
22      "path": "$LOCATION(ApplicationsPerformance)/localai/models",
23      "owner": {"user": "apps"},
24      "snapshot": {"id": "models"}
25    },
26    {
27      "path": "$LOCATION(ApplicationsPerformance)/localai/config",
28      "owner": {"user": "apps"},
29      "snapshot": {"id": "config"}
30    },
31    {
32      "path": "$LOCATION(ApplicationsPerformance)/localai/data",
33      "owner": {"user": "apps"},
34      "snapshot": {"id": "data"}
35    }
36  ],
37  "app_values": {
38    "storage": {
839      "backends": "$HOST_PATH($LOCATION(ApplicationsPerformance)/localai/backends)",
940      "models": "$HOST_PATH($LOCATION(ApplicationsPerformance)/localai/models)",
1041      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/localai/config)",
1142      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/localai/data)"
43    },
44    "network": {
1245      "web_port": {"bind_mode": "published", "port_number": 30286}
46    },
47    "resources": {
1348      "limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"},
1449      "gpus": "$GPU_CONFIG()"
50    }
51  }
52}

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.1. Latest change: “Regenerated for TrueNAS localai 1.1.42”.

    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 port 30286 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) › localai, App storage (fast) › localai › backends, App storage (fast) › localai › models, App storage (fast) › localai › config and App storage (fast) › localai › data. 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–36

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

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

    Line 39

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

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

    Line 40

  10. Where the app's settings is saved

    Where the app's settings is saved on your server: App storage (fast) › localai › config.

    Line 41

  11. Where the app's main data is saved

    Where the app's main data is saved on your server: App storage (fast) › localai › data.

    Line 42

  12. Web port: 30286

    The app's web page is published on port 30286. You don't need to remember it — clicking the app's card in HexOS takes you there.

    Line 45

  13. 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 48

  14. Graphics card access

    If your server has a supported graphics card, HexOS shares it with the app (useful for video conversion or AI features).

    Line 49