Hexy Templates

Newt

Newt is a fully user space WireGuard tunnel client and TCP/UDP proxy, designed to securely expose private resources controlled by Pangolin. By using Newt, you don't need to manage complex WireGuard tunnels and NATing.

Not yet tested networking Based on TrueNAS app v1.1.28 (Newt 1.18.1)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Newt and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
newt.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS newt 1.1.28"
6  },
37  "installation_questions": [
8    {
9      "question": "Pangolin endpoint",
10      "type": "text",
11      "key": "pangolin_endpoint",
12      "required": true
13    },
14    {
15      "question": "Newt id",
16      "type": "text",
17      "key": "newt_id",
18      "required": true
19    }
20  ],
421  "requirements": {"locations": [], "specifications": ["2CORE"]},
22  "app_values": {
23    "newt": {
524      "pangolin_endpoint": "$QUESTION(pangolin_endpoint)",
625      "newt_id": "$QUESTION(newt_id)",
726      "newt_secret": "$RANDOM_STRING(32)"
27    },
828    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
29  }
30}

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 newt 1.1.28”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–20

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 21

  5. Your answer: pangolin endpoint

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

    Line 24

  6. Your answer: newt id

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

    Line 25

  7. Auto-generated newt secret

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

    Line 26

  8. 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 28