Hexy Templates

Storj

Share your storage on the internet and earn.

Not yet tested storage Based on TrueNAS app v1.4.7 (Storj latest)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Storj and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
storj.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS storj 1.4.7"
6  },
37  "installation_questions": [
8    {
9      "question": "Wallet address",
10      "type": "password",
11      "key": "wallet_address",
12      "required": true
13    },
14    {
15      "question": "Email",
16      "type": "text",
17      "key": "email",
18      "required": true
19    },
20    {
21      "question": "Domain address",
22      "type": "text",
23      "key": "domain_address",
24      "required": true
25    }
26  ],
27  "requirements": {
428    "locations": ["ApplicationsPerformance"],
529    "specifications": ["2CORE"],
630    "permissions": ["READ_WRITE_LOCATIONS"],
731    "ports": [14002, 28967]
32  },
833  "ensure_directories_exists": [
34    {"path": "$LOCATION(ApplicationsPerformance)"},
35    {"path": "$LOCATION(ApplicationsPerformance)/storj"},
36    {
37      "path": "$LOCATION(ApplicationsPerformance)/storj/identity",
38      "owner": {"user": "apps"},
39      "snapshot": {"id": "identity"}
40    },
41    {
42      "path": "$LOCATION(ApplicationsPerformance)/storj/data",
43      "owner": {"user": "apps"},
44      "snapshot": {"id": "data"}
45    }
46  ],
47  "app_values": {
48    "storj": {
949      "wallet_address": "$QUESTION(wallet_address)",
1050      "email": "$QUESTION(email)",
1151      "domain_address": "$QUESTION(domain_address)"
52    },
53    "storage": {
1254      "identity": "$HOST_PATH($LOCATION(ApplicationsPerformance)/storj/identity)",
1355      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/storj/data)"
56    },
57    "network": {
1458      "web_port": {"bind_mode": "published", "port_number": 14002},
1559      "p2p_port": {"bind_mode": "published", "port_number": 28967}
60    },
1661    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
62  }
63}

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 storj 1.4.7”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Wallet address, Email and Domain address. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–26

  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 28

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 29

  6. Permission to use your folders

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

    Line 30

  7. Network ports

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

    Line 31

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › storj, App storage (fast) › storj › identity and App storage (fast) › storj › 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 33–46

  9. Your answer: wallet address

    Filled in with what you typed for “wallet address” when you installed.

    Line 49

  10. Your answer: email

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

    Line 50

  11. Your answer: domain address

    Filled in with what you typed for “domain address” when you installed.

    Line 51

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

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

    Line 54

  13. Where the app's main data is saved

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

    Line 55

  14. Web port: 14002

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

    Line 58

  15. P2p port: 28967

    Publishes the app's p2p port as 28967.

    Line 59

  16. 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 61