Hexy Templates

Photoprism

AI-powered app for browsing, organizing & sharing your photo collection.

Not yet tested media Based on TrueNAS app v1.4.12 (Photoprism 260919)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Photoprism and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
photoprism.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS photoprism 1.4.12"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "Media"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [20800]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/photoprism"},
16    {"path": "$LOCATION(Media)", "network_share": true},
17    {
18      "path": "$LOCATION(ApplicationsPerformance)/photoprism/import",
19      "snapshot": {"id": "import"}
20    },
21    {
22      "path": "$LOCATION(ApplicationsPerformance)/photoprism/storage",
23      "snapshot": {"id": "storage"}
24    },
25    {
26      "path": "$LOCATION(ApplicationsPerformance)/photoprism/originals",
27      "snapshot": {"id": "originals"}
28    }
29  ],
30  "app_values": {
31    "storage": {
832      "import": "$HOST_PATH($LOCATION(ApplicationsPerformance)/photoprism/import)",
933      "storage": "$HOST_PATH($LOCATION(ApplicationsPerformance)/photoprism/storage)",
1034      "originals": "$HOST_PATH($LOCATION(ApplicationsPerformance)/photoprism/originals)",
1135      "additional_storage": [
36        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
37      ]
38    },
39    "network": {
1240      "web_port": {"bind_mode": "published", "port_number": 20800}
41    },
42    "resources": {
1343      "limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"},
1444      "gpus": "$GPU_CONFIG()"
45    }
46  }
47}

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 photoprism 1.4.12”.

    Lines 3–6

  3. 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 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 20800 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) › photoprism, App storage (fast) › photoprism › import, App storage (fast) › photoprism › storage and App storage (fast) › photoprism › originals. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–29

  8. Where the app's “import” files is saved

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

    Line 32

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

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

    Line 33

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

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

    Line 34

  11. Your shared folders

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

    Lines 35–37

  12. Web port: 20800

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

    Line 40

  13. 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 43

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