Hexy Templates

SeaweedFS

SeaweedFS is a fast distributed storage system for blobs, objects, files, and data lake, for billions of files!

Not yet tested storage Based on TrueNAS app v1.1.40 (SeaweedFS 4.48)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find SeaweedFS and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
seaweedfs-community.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS seaweedfs 1.1.40"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30200, 30201, 30202, 30203, 30204]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/seaweedfs-community"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/seaweedfs-community/data",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "data"}
20    }
21  ],
22  "app_values": {
23    "storage": {
824      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/seaweedfs-community/data)"
25    },
26    "network": {
927      "master_port": {"bind_mode": "published", "port_number": 30200},
1028      "volume_port": {"bind_mode": "published", "port_number": 30201},
1129      "filer_port": {"bind_mode": "published", "port_number": 30202},
1230      "s3_port": {"bind_mode": "published", "port_number": 30203},
1331      "webdav_port": {"bind_mode": "published", "port_number": 30204}
32    },
1433    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
34  }
35}

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 seaweedfs 1.1.40”.

    Lines 3–6

  3. 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 8

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 9

  5. Permission to use your folders

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

    Line 10

  6. Network ports

    The app needs ports 30200, 30201, 30202, 30203 and 30204 to be free on your server. A port is like an apartment number for your server's address.

    Line 11

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › seaweedfs-community and App storage (fast) › seaweedfs-community › 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 13–21

  8. Where the app's main data is saved

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

    Line 24

  9. Master port: 30200

    Publishes the app's master port as 30200.

    Line 27

  10. Volume port: 30201

    Publishes the app's volume port as 30201.

    Line 28

  11. Filer port: 30202

    Publishes the app's filer port as 30202.

    Line 29

  12. S3 port: 30203

    Publishes the app's s3 port as 30203.

    Line 30

  13. Webdav port: 30204

    Publishes the app's webdav port as 30204.

    Line 31

  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 33