Hexy Templates

Arti

Arti is an experimental Tor implementation written in Rust, and it is designed to be modular, reusable, and easy to audit.

Not yet tested networking Based on TrueNAS app v1.3.17 (Arti 2.6.0)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Arti and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
arti.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS arti 1.3.17"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [9150]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/arti"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/arti/arti_config",
18      "snapshot": {"id": "arti_config"}
19    },
20    {
21      "path": "$LOCATION(ApplicationsPerformance)/arti/arti_state",
22      "snapshot": {"id": "arti_state"}
23    }
24  ],
25  "app_values": {
26    "storage": {
827      "arti_config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/arti/arti_config)",
928      "arti_state": "$HOST_PATH($LOCATION(ApplicationsPerformance)/arti/arti_state)"
29    },
30    "network": {
1031      "socks_port": {"bind_mode": "published", "port_number": 9150}
32    },
1133    "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 arti 1.3.17”.

    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 port 9150 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) › arti, App storage (fast) › arti › arti_config and App storage (fast) › arti › arti_state. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–24

  8. Where the app's “arti config” files is saved

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

    Line 27

  9. Where the app's “arti state” files is saved

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

    Line 28

  10. Socks port: 9150

    Publishes the app's socks port as 9150.

    Line 31

  11. 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