Hexy Templates

Piped

An alternative privacy-friendly YouTube frontend which is efficient by design.

Not yet tested media Based on TrueNAS app v1.2.31 (Piped latest)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Piped and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
piped.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS piped 1.2.31"
6  },
37  "installation_questions": [
8    {
9      "question": "Backend url",
10      "type": "password",
11      "key": "backend_url",
12      "required": true
13    },
14    {
15      "question": "Proxy url",
16      "type": "password",
17      "key": "proxy_url",
18      "required": true
19    }
20  ],
21  "requirements": {
422    "locations": ["ApplicationsPerformance", "Media"],
523    "specifications": ["2CORE"],
624    "permissions": ["READ_WRITE_LOCATIONS"],
725    "ports": [30271, 30272, 30273]
26  },
827  "ensure_directories_exists": [
28    {"path": "$LOCATION(ApplicationsPerformance)"},
29    {"path": "$LOCATION(ApplicationsPerformance)/piped"},
30    {"path": "$LOCATION(Media)", "network_share": true},
31    {
32      "path": "$LOCATION(ApplicationsPerformance)/piped/postgres_data",
33      "owner": {"user": "netdata", "group": "docker"},
34      "snapshot": {"id": "postgres_data"}
35    }
36  ],
37  "app_values": {
38    "piped": {
939      "db_password": "$RANDOM_STRING(16)",
1040      "backend_url": "$QUESTION(backend_url)",
1141      "frontend_url": "http://$SERVER_LAN_IP:30271",
1242      "proxy_url": "$QUESTION(proxy_url)"
43    },
44    "storage": {
1345      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/piped/postgres_data)",
1446      "additional_storage": [
47        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
48      ]
49    },
50    "network": {
1551      "backend_port": {"bind_mode": "published", "port_number": 30271},
1652      "frontend_port": {"bind_mode": "published", "port_number": 30272},
1753      "proxy_port": {"bind_mode": "published", "port_number": 30273}
54    },
1855    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
56  }
57}

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 piped 1.2.31”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Backend url and Proxy url. 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) and Media. 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 ports 30271, 30272 and 30273 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) › piped and App storage (fast) › piped › 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 27–36

  9. Auto-generated db password

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

    Line 39

  10. Your answer: backend url

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

    Line 40

  11. Your server's address (frontend url)

    Automatically set to your server's address on your home network (http://your-server-ip:30271).

    Line 41

  12. Your answer: proxy url

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

    Line 42

  13. Where the app's database is saved

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

    Line 45

  14. Your shared folders

    Gives the app access to your existing files: Media appears inside the app as /media.

    Lines 46–48

  15. Backend port: 30271

    Publishes the app's backend port as 30271.

    Line 51

  16. Frontend port: 30272

    Publishes the app's frontend port as 30272.

    Line 52

  17. Proxy port: 30273

    Publishes the app's proxy port as 30273.

    Line 53

  18. 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 55