Hexy Templates

Versity Gateway

The Versity Gateway serves as a bridge between file based, POSIX, storage systems and applications that rely on S3 object interfaces. It enables applications to interact with file storage using familiar S3 operations like put and get, allowing for easy integration and compatibility.

Not yet tested storage Based on TrueNAS app v1.1.15 (Versity Gateway v1.8.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 Versity Gateway and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
versitygw.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS versitygw 1.1.15"
6  },
37  "installation_questions": [
8    {
9      "question": "Root user access key",
10      "type": "password",
11      "key": "root_user_access_key",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [30355, 30157]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/versitygw"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/versitygw/buckets",
26      "owner": {"user": "apps"},
27      "snapshot": {"id": "buckets"}
28    }
29  ],
30  "app_values": {
31    "versity": {
932      "root_user_access_key": "$QUESTION(root_user_access_key)",
1033      "root_user_secret_access_key": "$RANDOM_STRING(32)"
34    },
35    "storage": {
1136      "buckets": "$HOST_PATH($LOCATION(ApplicationsPerformance)/versitygw/buckets)"
37    },
38    "network": {
1239      "webui_port": {"bind_mode": "published", "port_number": 30355},
1340      "api_port": {"bind_mode": "published", "port_number": 30157}
41    },
1442    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
43  }
44}

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 versitygw 1.1.15”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Root user access key. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–14

  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 16

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 17

  6. Permission to use your folders

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

    Line 18

  7. Network ports

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

    Line 19

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › versitygw and App storage (fast) › versitygw › buckets. 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 21–29

  9. Your answer: root user access key

    Filled in with what you typed for “root user access key” when you installed.

    Line 32

  10. Auto-generated root user secret access key

    HexOS makes up a long random root user secret access key during install. It's only used inside Versity Gateway, so you never need to know it.

    Line 33

  11. Where the app's “buckets” files is saved

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

    Line 36

  12. Webui port: 30355

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

    Line 39

  13. Api port: 30157

    Publishes the app's api port as 30157.

    Line 40

  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 42