Hexy Templates

Tube Archivist

Your self hosted YouTube media server

Not yet tested media Based on TrueNAS app v1.2.24 (Tube Archivist v0.5.12)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Tube Archivist and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
tubearchivist.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS tubearchivist 1.2.24"
6  },
37  "installation_questions": [
8    {
9      "question": "Elastic password",
10      "type": "password",
11      "key": "elastic_password",
12      "required": true
13    },
14    {
15      "question": "Username",
16      "type": "text",
17      "key": "username",
18      "required": true
19    },
20    {
21      "question": "Password",
22      "type": "password",
23      "key": "password",
24      "required": true
25    }
26  ],
27  "requirements": {
428    "locations": [
29      "ApplicationsPerformance",
30      "ApplicationsCapacity",
31      "Media"
32    ],
533    "specifications": ["2CORE"],
634    "permissions": ["READ_WRITE_LOCATIONS"],
735    "ports": [30247]
36  },
837  "ensure_directories_exists": [
38    {"path": "$LOCATION(ApplicationsPerformance)"},
39    {"path": "$LOCATION(ApplicationsPerformance)/tubearchivist"},
40    {"path": "$LOCATION(ApplicationsCapacity)"},
41    {"path": "$LOCATION(ApplicationsCapacity)/tubearchivist"},
42    {"path": "$LOCATION(Media)", "network_share": true},
43    {
44      "path": "$LOCATION(ApplicationsPerformance)/tubearchivist/youtube",
45      "snapshot": {"id": "youtube"}
46    },
47    {"path": "$LOCATION(ApplicationsCapacity)/tubearchivist/cache"},
48    {
49      "path": "$LOCATION(ApplicationsPerformance)/tubearchivist/es_data",
50      "snapshot": {"id": "es_data"}
51    }
52  ],
53  "app_values": {
54    "tube": {
955      "elastic_password": "$QUESTION(elastic_password)",
1056      "redis_password": "$RANDOM_STRING(16)",
1157      "username": "$QUESTION(username)",
1258      "password": "$QUESTION(password)"
59    },
60    "storage": {
1361      "youtube": "$HOST_PATH($LOCATION(ApplicationsPerformance)/tubearchivist/youtube)",
1462      "cache": "$HOST_PATH($LOCATION(ApplicationsCapacity)/tubearchivist/cache)",
1563      "es_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/tubearchivist/es_data)",
1664      "additional_storage": [
65        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
66      ]
67    },
68    "network": {
1769      "web_port": {"bind_mode": "published", "port_number": 30247}
70    },
1871    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
72  }
73}

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 tubearchivist 1.2.24”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–26

  4. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast), App storage (large) and Media. If one isn't set up yet, HexOS will ask you to pick a place for it.

    Lines 28–32

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 33

  6. Permission to use your folders

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

    Line 34

  7. Network ports

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

    Line 35

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › tubearchivist, App storage (large) › tubearchivist, App storage (fast) › tubearchivist › youtube, App storage (large) › tubearchivist › cache and App storage (fast) › tubearchivist › es_data. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 37–52

  9. Your answer: elastic password

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

    Line 55

  10. Auto-generated redis password

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

    Line 56

  11. Your answer: username

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

    Line 57

  12. Your answer: password

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

    Line 58

  13. Where the app's “youtube” files is saved

    Where the app's “youtube” files is saved on your server: App storage (fast) › tubearchivist › youtube.

    Line 61

  14. Where temporary cache files is saved

    Where temporary cache files is saved on your server: App storage (large) › tubearchivist › cache.

    Line 62

  15. Where the app's “es data” files is saved

    Where the app's “es data” files is saved on your server: App storage (fast) › tubearchivist › es_data.

    Line 63

  16. Your shared folders

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

    Lines 64–66

  17. Web port: 30247

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

    Line 69

  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 71