Hexy Templates

AudioMuse-AI

AudioMuse-AI - A self-hosted music playlist generator using sonic analysis to discover related tracks

Not yet tested media Based on TrueNAS app v1.0.44 (AudioMuse-AI 3.6.3)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find AudioMuse-AI and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
audiomuse-ai.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS audiomuse-ai 1.0.44"
6  },
7  "requirements": {
38    "locations": [
9      "ApplicationsCapacity",
10      "ApplicationsPerformance",
11      "Media"
12    ],
413    "specifications": ["2CORE"],
514    "permissions": ["READ_WRITE_LOCATIONS"],
615    "ports": [30431]
16  },
717  "ensure_directories_exists": [
18    {"path": "$LOCATION(ApplicationsCapacity)"},
19    {"path": "$LOCATION(ApplicationsCapacity)/audiomuse-ai"},
20    {"path": "$LOCATION(ApplicationsPerformance)"},
21    {"path": "$LOCATION(ApplicationsPerformance)/audiomuse-ai"},
22    {"path": "$LOCATION(Media)", "network_share": true},
23    {
24      "path": "$LOCATION(ApplicationsCapacity)/audiomuse-ai/temp_audio",
25      "owner": {"user": "apps"}
26    },
27    {
28      "path": "$LOCATION(ApplicationsPerformance)/audiomuse-ai/postgres_data",
29      "owner": {"user": "netdata", "group": "docker"},
30      "snapshot": {"id": "postgres_data"}
31    }
32  ],
33  "app_values": {
34    "audiomuse": {
835      "db_password": "$RANDOM_STRING(16)",
936      "redis_password": "$RANDOM_STRING(16)"
37    },
38    "storage": {
1039      "temp_audio": "$HOST_PATH($LOCATION(ApplicationsCapacity)/audiomuse-ai/temp_audio)",
1140      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/audiomuse-ai/postgres_data)",
1241      "additional_storage": [
42        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
43      ]
44    },
45    "network": {
1346      "web_port": {"bind_mode": "published", "port_number": 30431}
47    },
48    "resources": {
1449      "limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"},
1550      "gpus": "$GPU_CONFIG()"
51    }
52  }
53}

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 audiomuse-ai 1.0.44”.

    Lines 3–6

  3. Storage locations it needs

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

    Lines 8–12

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 13

  5. Permission to use your folders

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

    Line 14

  6. Network ports

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

    Line 15

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (large) › audiomuse-ai, App storage (fast) › audiomuse-ai, App storage (large) › audiomuse-ai › temp_audio and App storage (fast) › audiomuse-ai › 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 17–32

  8. Auto-generated db password

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

    Line 35

  9. Auto-generated redis password

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

    Line 36

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

    Where the app's “temp audio” files is saved on your server: App storage (large) › audiomuse-ai › temp_audio.

    Line 39

  11. Where the app's database is saved

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

    Line 40

  12. Your shared folders

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

    Lines 41–43

  13. Web port: 30431

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

    Line 46

  14. 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

  15. Graphics card access

    If your server has a supported graphics card, HexOS shares it with the app (useful for video conversion or AI features).

    Line 50