Hexy Templates

Hoppscotch

Hoppscotch is a lightweight, web-based API development suite.

Not yet tested development Based on TrueNAS app v1.2.45 (Hoppscotch 2026.9.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 Hoppscotch and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
hoppscotch.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS hoppscotch 1.2.45"
6  },
37  "installation_questions": [
8    {
9      "question": "Frontend",
10      "type": "text",
11      "key": "frontend",
12      "required": true
13    },
14    {
15      "question": "Backend",
16      "type": "text",
17      "key": "backend",
18      "required": true
19    },
20    {
21      "question": "Admin",
22      "type": "text",
23      "key": "admin",
24      "required": true
25    },
26    {
27      "question": "App bundle",
28      "type": "text",
29      "key": "app_bundle",
30      "required": true
31    }
32  ],
33  "requirements": {
434    "locations": ["ApplicationsPerformance"],
535    "specifications": ["2CORE"],
636    "permissions": ["READ_WRITE_LOCATIONS"],
737    "ports": [33000, 33170, 33100, 33200]
38  },
839  "ensure_directories_exists": [
40    {"path": "$LOCATION(ApplicationsPerformance)"},
41    {"path": "$LOCATION(ApplicationsPerformance)/hoppscotch"},
42    {
43      "path": "$LOCATION(ApplicationsPerformance)/hoppscotch/postgres_data",
44      "owner": {"user": "netdata", "group": "docker"},
45      "snapshot": {"id": "postgres_data"}
46    }
47  ],
48  "app_values": {
49    "hoppscotch": {
950      "db_password": "$RANDOM_STRING(16)",
1051      "data_encryption_key": "$RANDOM_STRING(32)",
52      "urls": {
1153        "frontend": "$QUESTION(frontend)",
1254        "backend": "$QUESTION(backend)",
1355        "admin": "$QUESTION(admin)",
1456        "app_bundle": "$QUESTION(app_bundle)"
57      }
58    },
59    "storage": {
1560      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/hoppscotch/postgres_data)"
61    },
62    "network": {
1663      "frontend_web_port": {
64        "bind_mode": "published",
65        "port_number": 33000
66      },
1767      "backend_web_port": {
68        "bind_mode": "published",
69        "port_number": 33170
70      },
1871      "admin_web_port": {"bind_mode": "published", "port_number": 33100},
1972      "app_bundle_port": {
73        "bind_mode": "published",
74        "port_number": 33200
75      }
76    },
2077    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
78  }
79}

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 hoppscotch 1.2.45”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Frontend, Backend, Admin and App bundle. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–32

  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 34

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 35

  6. Permission to use your folders

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

    Line 36

  7. Network ports

    The app needs ports 33000, 33170, 33100 and 33200 to be free on your server. A port is like an apartment number for your server's address.

    Line 37

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › hoppscotch and App storage (fast) › hoppscotch › 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 39–47

  9. Auto-generated db password

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

    Line 50

  10. Auto-generated data encryption key

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

    Line 51

  11. Your answer: frontend

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

    Line 53

  12. Your answer: backend

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

    Line 54

  13. Your answer: admin

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

    Line 55

  14. Your answer: app bundle

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

    Line 56

  15. Where the app's database is saved

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

    Line 60

  16. Frontend web port: 33000

    Publishes the app's frontend web port as 33000.

    Lines 63–66

  17. Backend web port: 33170

    Publishes the app's backend web port as 33170.

    Lines 67–70

  18. Admin web port: 33100

    Publishes the app's admin web port as 33100.

    Line 71

  19. App bundle port: 33200

    Publishes the app's app bundle port as 33200.

    Lines 72–75

  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 77