Hexy Templates

Elastic Search

Elasticsearch is the distributed, RESTful search and analytics engine at the heart of the Elastic Stack.

Not yet tested monitoring Based on TrueNAS app v1.4.21 (Elastic Search 9.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 Elastic Search and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
elastic-search.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS elastic-search 1.4.21"
6  },
37  "installation_questions": [
8    {
9      "question": "Password",
10      "type": "password",
11      "key": "password",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [30003]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/elastic-search"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/elastic-search/data",
26      "snapshot": {"id": "data"}
27    }
28  ],
29  "app_values": {
930    "elastic": {"password": "$QUESTION(password)"},
31    "storage": {
1032      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/elastic-search/data)"
33    },
34    "network": {
1135      "web_port": {"bind_mode": "published", "port_number": 30003}
36    },
1237    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
38  }
39}

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 elastic-search 1.4.21”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Password. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–14

  4. 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 16

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 17

  6. Permission to use your folders

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

    Line 18

  7. Network ports

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

    Line 19

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › elastic-search and App storage (fast) › elastic-search › data. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 21–28

  9. Your answer: password

    Filled in with what you typed for “password” when you installed.

    Line 30

  10. Where the app's main data is saved

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

    Line 32

  11. Web port: 30003

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

    Line 35

  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 37