SeaweedFS
SeaweedFS is a fast distributed storage system for blobs, objects, files, and data lake, for billions of files!
- 1Copy the script below
- 2In HexOS, open Apps, find SeaweedFS and choose Custom Install
- 3Paste, then press Install — full guide with screenshots
1{
12 "version": 5,
23 "script": {
4 "version": "0.1.0",
5 "changeLog": "Auto-generated draft from TrueNAS seaweedfs 1.2.39"
6 },
37 "installation_questions": [
8 {
9 "question": "Admin user",
10 "type": "text",
11 "key": "admin_user",
12 "required": true
13 },
14 {
15 "question": "Admin password",
16 "type": "password",
17 "key": "admin_password",
18 "required": true
19 }
20 ],
21 "requirements": {
422 "locations": ["ApplicationsPerformance"],
523 "specifications": ["2CORE"],
624 "permissions": ["READ_WRITE_LOCATIONS"],
725 "ports": [30300, 30301, 30302, 30303, 30304]
26 },
827 "ensure_directories_exists": [
28 {"path": "$LOCATION(ApplicationsPerformance)"},
29 {"path": "$LOCATION(ApplicationsPerformance)/seaweedfs"},
30 {
31 "path": "$LOCATION(ApplicationsPerformance)/seaweedfs/admin_data",
32 "owner": {"user": "apps"},
33 "snapshot": {"id": "admin_data"}
34 },
35 {
36 "path": "$LOCATION(ApplicationsPerformance)/seaweedfs/worker_data",
37 "owner": {"user": "apps"},
38 "snapshot": {"id": "worker_data"}
39 },
40 {
41 "path": "$LOCATION(ApplicationsPerformance)/seaweedfs/master_data",
42 "owner": {"user": "apps"},
43 "snapshot": {"id": "master_data"}
44 },
45 {
46 "path": "$LOCATION(ApplicationsPerformance)/seaweedfs/filer_data",
47 "owner": {"user": "apps"},
48 "snapshot": {"id": "filer_data"}
49 },
50 {
51 "path": "$LOCATION(ApplicationsPerformance)/seaweedfs/volume_data",
52 "owner": {"user": "apps"},
53 "snapshot": {"id": "volume_data"}
54 }
55 ],
56 "app_values": {
57 "seaweedfs": {
958 "admin_user": "$QUESTION(admin_user)",
1059 "admin_password": "$QUESTION(admin_password)"
60 },
61 "storage": {
1162 "admin_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/seaweedfs/admin_data)",
1263 "worker_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/seaweedfs/worker_data)",
1364 "master_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/seaweedfs/master_data)",
1465 "filer_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/seaweedfs/filer_data)",
1566 "volume_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/seaweedfs/volume_data)"
67 },
68 "network": {
1669 "admin_port": {"bind_mode": "published", "port_number": 30300},
1770 "master_port": {"bind_mode": "published", "port_number": 30301},
1871 "volume_port": {"bind_mode": "published", "port_number": 30302},
1972 "filer_port": {"bind_mode": "published", "port_number": 30303},
2073 "s3_port": {"bind_mode": "published", "port_number": 30304}
74 },
2175 "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
76 }
77}
What this script does
Hover or tap a box to see the lines it explains.
-
Script format
Tells HexOS this is a version 5 install script, so it knows how to read the rest.
Line 2
-
Script revision
This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS seaweedfs 1.2.39”.
Lines 3–6
-
Questions you'll be asked
Before installing, HexOS will ask you for: Admin user and Admin password. Your answers are slotted into the settings further down wherever you see $QUESTION(...).
Lines 7–20
-
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 22
-
Minimum hardware
Recommended minimum: 2 CPU cores.
Line 23
-
Permission to use your folders
Allows the app to read and write files inside the storage locations listed above — and nowhere else.
Line 24
-
Network ports
The app needs ports 30300, 30301, 30302, 30303 and 30304 to be free on your server. A port is like an apartment number for your server's address.
Line 25
-
Folders created on install
Creates the folders the app needs before it starts: App storage (fast) › seaweedfs, App storage (fast) › seaweedfs › admin_data, App storage (fast) › seaweedfs › worker_data, App storage (fast) › seaweedfs › master_data, App storage (fast) › seaweedfs › filer_data and App storage (fast) › seaweedfs › volume_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 27–55
-
Your answer: admin user
Filled in with what you typed for “admin user” when you installed.
Line 58
-
Your answer: admin password
Filled in with what you typed for “admin password” when you installed.
Line 59
-
Where the app's “admin data” files is saved
Where the app's “admin data” files is saved on your server: App storage (fast) › seaweedfs › admin_data.
Line 62
-
Where the app's “worker data” files is saved
Where the app's “worker data” files is saved on your server: App storage (fast) › seaweedfs › worker_data.
Line 63
-
Where the app's “master data” files is saved
Where the app's “master data” files is saved on your server: App storage (fast) › seaweedfs › master_data.
Line 64
-
Where the app's “filer data” files is saved
Where the app's “filer data” files is saved on your server: App storage (fast) › seaweedfs › filer_data.
Line 65
-
Where the app's “volume data” files is saved
Where the app's “volume data” files is saved on your server: App storage (fast) › seaweedfs › volume_data.
Line 66
-
Admin port: 30300
Publishes the app's admin port as 30300.
Line 69
-
Master port: 30301
Publishes the app's master port as 30301.
Line 70
-
Volume port: 30302
Publishes the app's volume port as 30302.
Line 71
-
Filer port: 30303
Publishes the app's filer port as 30303.
Line 72
-
S3 port: 30304
Publishes the app's s3 port as 30304.
Line 73
-
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 75