Hexy Templates

RustFS

RustFS is an open-source, S3-compatible high-performance object storage system supporting migration and coexistence with other S3-compatible platforms such as MinIO and Ceph.

Not yet tested storage Based on TrueNAS app v1.1.33 (RustFS 1.0.1)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find RustFS and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
rustfs.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS rustfs 1.1.33"
6  },
37  "installation_questions": [
8    {
9      "question": "Access key",
10      "type": "text",
11      "key": "access_key",
12      "required": true
13    }
14  ],
15  "requirements": {
16    "locations": [],
417    "specifications": ["2CORE"],
518    "ports": [30292, 30293]
19  },
20  "app_values": {
21    "rustfs": {
622      "access_key": "$QUESTION(access_key)",
723      "secret_key": "$RANDOM_STRING(32)"
24    },
25    "network": {
826      "api_port": {"bind_mode": "published", "port_number": 30292},
927      "web_port": {"bind_mode": "published", "port_number": 30293}
28    },
1029    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
30  }
31}

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 rustfs 1.1.33”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–14

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 17

  5. Network ports

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

    Line 18

  6. Your answer: access key

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

    Line 22

  7. Auto-generated secret key

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

    Line 23

  8. Api port: 30292

    Publishes the app's api port as 30292.

    Line 26

  9. Web port: 30293

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

    Line 27

  10. 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 29