Hexy Templates

Garage

An open-source distributed object storage service tailored for self-hosting.

Not yet tested storage Based on TrueNAS app v1.2.9 (Garage v2.4.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 Garage and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
garage.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS garage 1.2.9"
6  },
37  "installation_questions": [
8    {
9      "question": "Admin token",
10      "type": "password",
11      "key": "admin_token",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [30186, 30187, 30188, 30189, 30190]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/garage"},
24    {
25      "path": "$LOCATION(ApplicationsPerformance)/garage/config",
26      "owner": {"user": "apps"},
27      "snapshot": {"id": "config"}
28    },
29    {
30      "path": "$LOCATION(ApplicationsPerformance)/garage/metadata",
31      "owner": {"user": "apps"},
32      "snapshot": {"id": "metadata"}
33    },
34    {
35      "path": "$LOCATION(ApplicationsPerformance)/garage/data",
36      "owner": {"user": "apps"},
37      "snapshot": {"id": "data"}
38    },
39    {
40      "path": "$LOCATION(ApplicationsPerformance)/garage/metadata_snapshots",
41      "owner": {"user": "apps"},
42      "snapshot": {"id": "metadata_snapshots"}
43    }
44  ],
45  "app_values": {
46    "garage": {
947      "admin_token": "$QUESTION(admin_token)",
1048      "rpc_secret": "$RANDOM_STRING(32)"
49    },
50    "storage": {
1151      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/garage/config)",
1252      "metadata": "$HOST_PATH($LOCATION(ApplicationsPerformance)/garage/metadata)",
1353      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/garage/data)",
1454      "metadata_snapshots": "$HOST_PATH($LOCATION(ApplicationsPerformance)/garage/metadata_snapshots)"
55    },
56    "network": {
1557      "web_port": {"bind_mode": "published", "port_number": 30186},
1658      "rpc_port": {"bind_mode": "published", "port_number": 30187},
1759      "s3_port": {"bind_mode": "published", "port_number": 30188},
1860      "s3_web_port": {"bind_mode": "published", "port_number": 30189},
1961      "admin_port": {"bind_mode": "published", "port_number": 30190}
62    },
2063    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
64  }
65}

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 garage 1.2.9”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Admin token. 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 30186, 30187, 30188, 30189 and 30190 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) › garage, App storage (fast) › garage › config, App storage (fast) › garage › metadata, App storage (fast) › garage › data and App storage (fast) › garage › metadata_snapshots. 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–44

  9. Your answer: admin token

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

    Line 47

  10. Auto-generated rpc secret

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

    Line 48

  11. Where the app's settings is saved

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

    Line 51

  12. Where the app's “metadata” files is saved

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

    Line 52

  13. Where the app's main data is saved

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

    Line 53

  14. Where the app's “metadata snapshots” files is saved

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

    Line 54

  15. Web port: 30186

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

    Line 57

  16. Rpc port: 30187

    Publishes the app's rpc port as 30187.

    Line 58

  17. S3 port: 30188

    Publishes the app's s3 port as 30188.

    Line 59

  18. S3 web port: 30189

    Publishes the app's s3 web port as 30189.

    Line 60

  19. Admin port: 30190

    Publishes the app's admin port as 30190.

    Line 61

  20. 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 63