Hexy Templates

Immich Frame

An awesome way to display your photos as a digital photo frame

Not yet tested media Based on TrueNAS app v1.0.7 (Immich Frame v1.0.38.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 Immich Frame and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
immich-frame.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS immich-frame 1.0.7"
6  },
37  "installation_questions": [
8    {
9      "question": "Immich api key",
10      "type": "password",
11      "key": "immich_api_key",
12      "required": true
13    },
14    {
15      "question": "Immich url",
16      "type": "text",
17      "key": "immich_url",
18      "required": true
19    }
20  ],
21  "requirements": {
422    "locations": ["ApplicationsPerformance", "Media"],
523    "specifications": ["2CORE"],
624    "permissions": ["READ_WRITE_LOCATIONS"],
725    "ports": [30425]
26  },
827  "ensure_directories_exists": [
28    {"path": "$LOCATION(ApplicationsPerformance)"},
29    {"path": "$LOCATION(ApplicationsPerformance)/immich-frame"},
30    {"path": "$LOCATION(Media)", "network_share": true},
31    {
32      "path": "$LOCATION(ApplicationsPerformance)/immich-frame/config",
33      "owner": {"user": "apps"},
34      "snapshot": {"id": "config"}
35    }
36  ],
37  "app_values": {
38    "frame": {
939      "immich_api_key": "$QUESTION(immich_api_key)",
1040      "immich_url": "$QUESTION(immich_url)"
41    },
42    "storage": {
1143      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/immich-frame/config)",
1244      "additional_storage": [
45        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
46      ]
47    },
48    "network": {
1349      "web_port": {"bind_mode": "published", "port_number": 30425}
50    },
1451    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
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 immich-frame 1.0.7”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Immich api key and Immich url. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–20

  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 22

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 23

  6. Permission to use your folders

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

    Line 24

  7. Network ports

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

    Line 25

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › immich-frame and App storage (fast) › immich-frame › config. 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 27–36

  9. Your answer: immich api key

    Filled in with what you typed for “immich api key” when you installed.

    Line 39

  10. Your answer: immich url

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

    Line 40

  11. Where the app's settings is saved

    Where the app's settings is saved on your server: App storage (fast) › immich-frame › config.

    Line 43

  12. Your shared folders

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

    Lines 44–46

  13. Web port: 30425

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

    Line 49

  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 51