Hexy Templates

LibreChat

LibreChat is the ultimate open-source app for all your AI conversations, fully customizable and compatible with any AI provider — all in one sleek interface

Not yet tested productivity Based on TrueNAS app v1.2.74 (LibreChat v0.8.7)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find LibreChat and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
librechat.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS librechat 1.2.74"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "ApplicationsCapacity"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30284]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/librechat"},
16    {"path": "$LOCATION(ApplicationsCapacity)"},
17    {"path": "$LOCATION(ApplicationsCapacity)/librechat"},
18    {
19      "path": "$LOCATION(ApplicationsPerformance)/librechat/images",
20      "owner": {"user": "apps"},
21      "snapshot": {"id": "images"}
22    },
23    {
24      "path": "$LOCATION(ApplicationsPerformance)/librechat/uploads",
25      "owner": {"user": "apps"},
26      "snapshot": {"id": "uploads"}
27    },
28    {
29      "path": "$LOCATION(ApplicationsCapacity)/librechat/logs",
30      "owner": {"user": "apps"}
31    },
32    {
33      "path": "$LOCATION(ApplicationsPerformance)/librechat/meili_data",
34      "owner": {"user": "apps"},
35      "snapshot": {"id": "meili_data"}
36    },
37    {
38      "path": "$LOCATION(ApplicationsPerformance)/librechat/mongodb_data",
39      "owner": {"user": "netdata", "group": "docker"},
40      "snapshot": {"id": "mongodb_data"}
41    },
42    {
43      "path": "$LOCATION(ApplicationsPerformance)/librechat/postgres_data",
44      "owner": {"user": "netdata", "group": "docker"},
45      "snapshot": {"id": "postgres_data"}
46    }
47  ],
48  "app_values": {
49    "librechat": {
850      "pg_db_password": "$RANDOM_STRING(16)",
951      "mongo_db_password": "$RANDOM_STRING(16)",
1052      "meilisearch_master_key": "$RANDOM_STRING(32)",
1153      "jwt_secret": "$RANDOM_STRING(32)",
1254      "jwt_refresh_secret": "$RANDOM_STRING(32)"
55    },
56    "storage": {
1357      "images": "$HOST_PATH($LOCATION(ApplicationsPerformance)/librechat/images)",
1458      "uploads": "$HOST_PATH($LOCATION(ApplicationsPerformance)/librechat/uploads)",
1559      "logs": "$HOST_PATH($LOCATION(ApplicationsCapacity)/librechat/logs)",
1660      "meili_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/librechat/meili_data)",
1761      "mongodb_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/librechat/mongodb_data)",
1862      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/librechat/postgres_data)"
63    },
64    "network": {
1965      "web_port": {"bind_mode": "published", "port_number": 30284}
66    },
2067    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
68  }
69}

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 librechat 1.2.74”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast) and App storage (large). 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 30284 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) › librechat, App storage (large) › librechat, App storage (fast) › librechat › images, App storage (fast) › librechat › uploads, App storage (large) › librechat › logs, App storage (fast) › librechat › meili_data, App storage (fast) › librechat › mongodb_data and App storage (fast) › librechat › postgres_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–47

  8. Auto-generated pg db password

    HexOS makes up a long random pg db password during install. It's only used inside LibreChat, so you never need to know it.

    Line 50

  9. Auto-generated mongo db password

    HexOS makes up a long random mongo db password during install. It's only used inside LibreChat, so you never need to know it.

    Line 51

  10. Auto-generated meilisearch master key

    HexOS makes up a long random meilisearch master key during install. It's only used inside LibreChat, so you never need to know it.

    Line 52

  11. Auto-generated jwt secret

    HexOS makes up a long random jwt secret during install. It's only used inside LibreChat, so you never need to know it.

    Line 53

  12. Auto-generated jwt refresh secret

    HexOS makes up a long random jwt refresh secret during install. It's only used inside LibreChat, so you never need to know it.

    Line 54

  13. Where the app's “images” files is saved

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

    Line 57

  14. Where files you upload is saved

    Where files you upload is saved on your server: App storage (fast) › librechat › uploads.

    Line 58

  15. Where the app's log files is saved

    Where the app's log files is saved on your server: App storage (large) › librechat › logs.

    Line 59

  16. Where the app's “meili data” files is saved

    Where the app's “meili data” files is saved on your server: App storage (fast) › librechat › meili_data.

    Line 60

  17. Where the app's “mongodb data” files is saved

    Where the app's “mongodb data” files is saved on your server: App storage (fast) › librechat › mongodb_data.

    Line 61

  18. Where the app's database is saved

    Where the app's database is saved on your server: App storage (fast) › librechat › postgres_data.

    Line 62

  19. Web port: 30284

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

    Line 65

  20. 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 67