Hexy Templates

Invidious

Invidious is an alternative front-end to YouTube

Not yet tested media Based on TrueNAS app v1.7.37 (Invidious 2.20260804.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 Invidious and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
invidious.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS invidious 1.7.37"
6  },
37  "installation_questions": [
8    {
9      "question": "Companion key",
10      "type": "password",
11      "key": "companion_key",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": [
17      "ApplicationsPerformance",
18      "ApplicationsCapacity",
19      "Media"
20    ],
521    "specifications": ["2CORE"],
622    "permissions": ["READ_WRITE_LOCATIONS"],
723    "ports": [31008]
24  },
825  "ensure_directories_exists": [
26    {"path": "$LOCATION(ApplicationsPerformance)"},
27    {"path": "$LOCATION(ApplicationsPerformance)/invidious"},
28    {"path": "$LOCATION(ApplicationsCapacity)"},
29    {"path": "$LOCATION(ApplicationsCapacity)/invidious"},
30    {"path": "$LOCATION(Media)", "network_share": true},
31    {
32      "path": "$LOCATION(ApplicationsPerformance)/invidious/config",
33      "snapshot": {"id": "config"}
34    },
35    {
36      "path": "$LOCATION(ApplicationsCapacity)/invidious/companion_cache"
37    },
38    {
39      "path": "$LOCATION(ApplicationsPerformance)/invidious/postgres_data",
40      "owner": {"user": "netdata", "group": "docker"},
41      "snapshot": {"id": "postgres_data"}
42    }
43  ],
44  "app_values": {
45    "invidious": {
946      "db_password": "$RANDOM_STRING(16)",
1047      "hmac_secret": "$RANDOM_STRING(32)",
1148      "companion_key": "$QUESTION(companion_key)"
49    },
50    "storage": {
1251      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/invidious/config)",
1352      "companion_cache": "$HOST_PATH($LOCATION(ApplicationsCapacity)/invidious/companion_cache)",
1453      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/invidious/postgres_data)",
1554      "additional_storage": [
55        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
56      ]
57    },
58    "network": {
1659      "web_port": {"bind_mode": "published", "port_number": 31008}
60    },
1761    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
62  }
63}

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 invidious 1.7.37”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–14

  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 16–20

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 21

  6. Permission to use your folders

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

    Line 22

  7. Network ports

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

    Line 23

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › invidious, App storage (large) › invidious, App storage (fast) › invidious › config, App storage (large) › invidious › companion_cache and App storage (fast) › invidious › 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 25–43

  9. Auto-generated db password

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

    Line 46

  10. Auto-generated hmac secret

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

    Line 47

  11. Your answer: companion key

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

    Line 48

  12. Where the app's settings is saved

    Where the app's settings is saved on your server: App storage (fast) › invidious › config.

    Line 51

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

    Where the app's “companion cache” files is saved on your server: App storage (large) › invidious › companion_cache.

    Line 52

  14. Where the app's database is saved

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

    Line 53

  15. Your shared folders

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

    Lines 54–56

  16. Web port: 31008

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

    Line 59

  17. 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 61