Hexy Templates

LibreDB Studio

LibreDB Studio is an open-source, self-hosted SQL IDE. A web-based client to browse, query, and manage your SQL databases.

Not yet tested database Based on TrueNAS app v1.0.15 (LibreDB Studio 0.17.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 LibreDB Studio and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
libredb-studio.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS libredb-studio 1.0.15"
6  },
37  "installation_questions": [
8    {
9      "question": "Admin email",
10      "type": "text",
11      "key": "admin_email",
12      "required": true
13    },
14    {
15      "question": "Admin password",
16      "type": "password",
17      "key": "admin_password",
18      "required": true
19    }
20  ],
21  "requirements": {
422    "locations": ["ApplicationsPerformance"],
523    "specifications": ["2CORE"],
624    "permissions": ["READ_WRITE_LOCATIONS"],
725    "ports": [30469]
26  },
827  "ensure_directories_exists": [
28    {"path": "$LOCATION(ApplicationsPerformance)"},
29    {"path": "$LOCATION(ApplicationsPerformance)/libredb-studio"},
30    {
31      "path": "$LOCATION(ApplicationsPerformance)/libredb-studio/data",
32      "owner": {"user": "apps"},
33      "snapshot": {"id": "data"}
34    }
35  ],
36  "app_values": {
37    "libredb": {
938      "admin_email": "$QUESTION(admin_email)",
1039      "admin_password": "$QUESTION(admin_password)",
1140      "jwt_secret": "$RANDOM_STRING(32)"
41    },
42    "storage": {
1243      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/libredb-studio/data)"
44    },
45    "network": {
1346      "web_port": {"bind_mode": "published", "port_number": 30469}
47    },
1448    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
49  }
50}

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 libredb-studio 1.0.15”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–20

  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 22

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 23

  6. Permission to use your folders

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

    Line 24

  7. Network ports

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

    Line 25

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › libredb-studio and App storage (fast) › libredb-studio › 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 27–35

  9. Your answer: admin email

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

    Line 38

  10. Your answer: admin password

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

    Line 39

  11. Auto-generated jwt secret

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

    Line 40

  12. Where the app's main data is saved

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

    Line 43

  13. Web port: 30469

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

    Line 46

  14. 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