Hexy Templates

Iconik Storage Gateway

The iconik Storage Gateway (ISG) allows you to use your on-premise storage with iconik in the cloud.

Not yet tested productivity Based on TrueNAS app v1.1.7 (Iconik Storage Gateway 3.15.4)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Iconik Storage Gateway and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
iconik-storage-gateway.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS iconik-storage-gateway 1.1.7"
6  },
37  "installation_questions": [
8    {
9      "question": "Auth token",
10      "type": "password",
11      "key": "auth_token",
12      "required": true
13    },
14    {
15      "question": "App id",
16      "type": "password",
17      "key": "app_id",
18      "required": true
19    },
20    {
21      "question": "Storage id",
22      "type": "password",
23      "key": "storage_id",
24      "required": true
25    }
26  ],
27  "requirements": {
428    "locations": ["ApplicationsPerformance"],
529    "specifications": ["2CORE"],
630    "permissions": ["READ_WRITE_LOCATIONS"]
31  },
732  "ensure_directories_exists": [
33    {"path": "$LOCATION(ApplicationsPerformance)"},
34    {
35      "path": "$LOCATION(ApplicationsPerformance)/iconik-storage-gateway"
36    },
37    {
38      "path": "$LOCATION(ApplicationsPerformance)/iconik-storage-gateway/data",
39      "owner": {"user": "apps"},
40      "snapshot": {"id": "data"}
41    }
42  ],
43  "app_values": {
44    "iconik": {
845      "auth_token": "$QUESTION(auth_token)",
946      "app_id": "$QUESTION(app_id)",
1047      "storage_id": "$QUESTION(storage_id)"
48    },
49    "storage": {
1150      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/iconik-storage-gateway/data)"
51    },
1252    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
53  }
54}

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 iconik-storage-gateway 1.1.7”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Auth token, App id and Storage id. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–26

  4. Storage locations it needs

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

    Line 28

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 29

  6. Permission to use your folders

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

    Line 30

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › iconik-storage-gateway and App storage (fast) › iconik-storage-gateway › 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 32–42

  8. Your answer: auth token

    Filled in with what you typed for “auth token” when you installed.

    Line 45

  9. Your answer: app id

    Filled in with what you typed for “app id” when you installed.

    Line 46

  10. Your answer: storage id

    Filled in with what you typed for “storage id” when you installed.

    Line 47

  11. Where the app's main data is saved

    Where the app's main data is saved on your server: App storage (fast) › iconik-storage-gateway › data.

    Line 50

  12. 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 52