Hexy Templates

Koel

Music streaming solution that works.

Not yet tested media Based on TrueNAS app v1.0.5 (Koel 9.15.0)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Koel and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
koel.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS koel 1.0.5"
6  },
7  "requirements": {
38    "locations": ["Music", "ApplicationsPerformance", "Media"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30395]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(Music)", "network_share": true},
15    {"path": "$LOCATION(ApplicationsPerformance)"},
16    {"path": "$LOCATION(ApplicationsPerformance)/koel"},
17    {"path": "$LOCATION(Media)", "network_share": true},
18    {
19      "path": "$LOCATION(ApplicationsPerformance)/koel/search_index",
20      "snapshot": {"id": "search_index"}
21    },
22    {
23      "path": "$LOCATION(ApplicationsPerformance)/koel/image_storage",
24      "snapshot": {"id": "image_storage"}
25    },
26    {
27      "path": "$LOCATION(ApplicationsPerformance)/koel/postgres_data",
28      "owner": {"user": "netdata", "group": "docker"},
29      "snapshot": {"id": "postgres_data"}
30    }
31  ],
32  "app_values": {
33    "koel": {
834      "db_password": "$RANDOM_STRING(16)",
935      "app_key": "$RANDOM_STRING(32)"
36    },
37    "storage": {
1038      "music": "$HOST_PATH($LOCATION(Music))",
1139      "search_index": "$HOST_PATH($LOCATION(ApplicationsPerformance)/koel/search_index)",
1240      "image_storage": "$HOST_PATH($LOCATION(ApplicationsPerformance)/koel/image_storage)",
1341      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/koel/postgres_data)",
1442      "additional_storage": [
43        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
44      ]
45    },
46    "network": {
1547      "web_port": {"bind_mode": "published", "port_number": 30395}
48    },
1649    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
50  }
51}

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 koel 1.0.5”.

    Lines 3–6

  3. Storage locations it needs

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

    Line 8

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 9

  5. Permission to use your folders

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

    Line 10

  6. Network ports

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

    Line 11

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › koel, App storage (fast) › koel › search_index, App storage (fast) › koel › image_storage and App storage (fast) › koel › 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 13–31

  8. Auto-generated db password

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

    Line 34

  9. Auto-generated app key

    HexOS makes up a long random app key during install. It's only used inside Koel, so you never need to know it.

    Line 35

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

    Where the app's “music” files is saved on your server: Music.

    Line 38

  11. Where the app's “search index” files is saved

    Where the app's “search index” files is saved on your server: App storage (fast) › koel › search_index.

    Line 39

  12. Where the app's “image storage” files is saved

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

    Line 40

  13. Where the app's database is saved

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

    Line 41

  14. Your shared folders

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

    Lines 42–44

  15. Web port: 30395

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

    Line 47

  16. 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 49