Hexy Templates

SparkyFitness

SparkyFitness is a self-hosted fitness and nutrition tracking application with AI coaching, workout logging, and health data integrations.

Not yet tested fitness Based on TrueNAS app v1.0.23 (SparkyFitness v1.7.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 SparkyFitness and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
sparkyfitness.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS sparkyfitness 1.0.23"
6  },
7  "requirements": {
38    "locations": ["ApplicationsCapacity", "ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30448]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsCapacity)"},
15    {"path": "$LOCATION(ApplicationsCapacity)/sparkyfitness"},
16    {"path": "$LOCATION(ApplicationsPerformance)"},
17    {"path": "$LOCATION(ApplicationsPerformance)/sparkyfitness"},
18    {
19      "path": "$LOCATION(ApplicationsCapacity)/sparkyfitness/backup",
20      "owner": {"user": "apps"}
21    },
22    {
23      "path": "$LOCATION(ApplicationsPerformance)/sparkyfitness/uploads",
24      "owner": {"user": "apps"},
25      "snapshot": {"id": "uploads"}
26    },
27    {
28      "path": "$LOCATION(ApplicationsPerformance)/sparkyfitness/postgres_data",
29      "owner": {"user": "netdata", "group": "docker"},
30      "snapshot": {"id": "postgres_data"}
31    }
32  ],
33  "app_values": {
34    "sparkyfitness": {
835      "db_password": "$RANDOM_STRING(16)",
936      "api_encryption_key": "$RANDOM_STRING(32)",
1037      "better_auth_secret": "$RANDOM_STRING(32)",
1138      "frontend_url": "http://$SERVER_LAN_IP:30448"
39    },
40    "storage": {
1241      "backup": "$HOST_PATH($LOCATION(ApplicationsCapacity)/sparkyfitness/backup)",
1342      "uploads": "$HOST_PATH($LOCATION(ApplicationsPerformance)/sparkyfitness/uploads)",
1443      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/sparkyfitness/postgres_data)"
44    },
45    "network": {
1546      "web_port": {"bind_mode": "published", "port_number": 30448}
47    },
1648    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
49  }
50}

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 sparkyfitness 1.0.23”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (large) and App storage (fast). 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 30448 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 (large) › sparkyfitness, App storage (fast) › sparkyfitness, App storage (large) › sparkyfitness › backup, App storage (fast) › sparkyfitness › uploads and App storage (fast) › sparkyfitness › 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–32

  8. Auto-generated db password

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

    Line 35

  9. Auto-generated api encryption key

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

    Line 36

  10. Auto-generated better auth secret

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

    Line 37

  11. Your server's address (frontend url)

    Automatically set to your server's address on your home network (http://your-server-ip:30448).

    Line 38

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

    Where the app's “backup” files is saved on your server: App storage (large) › sparkyfitness › backup.

    Line 41

  13. Where files you upload is saved

    Where files you upload is saved on your server: App storage (fast) › sparkyfitness › uploads.

    Line 42

  14. Where the app's database is saved

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

    Line 43

  15. Web port: 30448

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

    Line 46

  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 48