Hexy Templates

Airwave

Turn your Plex library into custom, always-on live TV channels, watchable on native apps for every screen.

Not yet tested media Based on TrueNAS app v1.0.1 (Airwave 0.15.13)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Airwave and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
airwave.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS airwave 1.0.1"
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      "question": "Server public url",
22      "type": "text",
23      "key": "server_public_url",
24      "required": true
25    },
26    {
27      "question": "Web public url",
28      "type": "text",
29      "key": "web_public_url",
30      "required": true
31    }
32  ],
33  "requirements": {
434    "locations": ["ApplicationsPerformance", "Media"],
535    "specifications": ["2CORE"],
636    "permissions": ["READ_WRITE_LOCATIONS"],
737    "ports": [30515, 30516]
38  },
839  "ensure_directories_exists": [
40    {"path": "$LOCATION(ApplicationsPerformance)"},
41    {"path": "$LOCATION(ApplicationsPerformance)/airwave"},
42    {"path": "$LOCATION(Media)", "network_share": true},
43    {
44      "path": "$LOCATION(ApplicationsPerformance)/airwave/postgres_data",
45      "owner": {"user": "netdata", "group": "docker"},
46      "snapshot": {"id": "postgres_data"}
47    },
48    {
49      "path": "$LOCATION(ApplicationsPerformance)/airwave/bumper_music",
50      "snapshot": {"id": "bumper_music"}
51    }
52  ],
53  "app_values": {
54    "airwave": {
955      "db_password": "$RANDOM_STRING(16)",
1056      "better_auth_secret": "$RANDOM_STRING(32)",
1157      "admin_email": "$QUESTION(admin_email)",
1258      "admin_password": "$QUESTION(admin_password)",
1359      "server_public_url": "$QUESTION(server_public_url)",
1460      "web_public_url": "$QUESTION(web_public_url)"
61    },
62    "storage": {
1563      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/airwave/postgres_data)",
1664      "bumper_music": "$HOST_PATH($LOCATION(ApplicationsPerformance)/airwave/bumper_music)",
1765      "additional_storage": [
66        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
67      ]
68    },
69    "network": {
1870      "server_port": {"bind_mode": "published", "port_number": 30515},
1971      "web_port": {"bind_mode": "published", "port_number": 30516}
72    },
2073    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
74  }
75}

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 airwave 1.0.1”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–32

  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 34

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 35

  6. Permission to use your folders

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

    Line 36

  7. Network ports

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

    Line 37

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › airwave, App storage (fast) › airwave › postgres_data and App storage (fast) › airwave › bumper_music. 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 39–52

  9. Auto-generated db password

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

    Line 55

  10. Auto-generated better auth secret

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

    Line 56

  11. Your answer: admin email

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

    Line 57

  12. Your answer: admin password

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

    Line 58

  13. Your answer: server public url

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

    Line 59

  14. Your answer: web public url

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

    Line 60

  15. Where the app's database is saved

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

    Line 63

  16. Where the app's “bumper music” files is saved

    Where the app's “bumper music” files is saved on your server: App storage (fast) › airwave › bumper_music.

    Line 64

  17. Your shared folders

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

    Lines 65–67

  18. Server port: 30515

    Publishes the app's server port as 30515.

    Line 70

  19. Web port: 30516

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

    Line 71

  20. 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 73