Hexy Templates

I2P

I2P (Invisible Internet Protocol) is a universal anonymous network layer. All communications over I2P are anonymous and end-to-end encrypted, participants don't reveal their real IP addresses.

Not yet tested networking Based on TrueNAS app v1.1.12 (I2P i2p-2.11.0-9)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find I2P and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
i2p.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS i2p 1.1.12"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [7657, 4444, 4445]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/i2p"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/i2p/i2p_config",
18      "snapshot": {"id": "i2p_config"}
19    }
20  ],
21  "app_values": {
22    "storage": {
823      "i2p_config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/i2p/i2p_config)"
24    },
25    "network": {
926      "router_console_port": {
27        "bind_mode": "published",
28        "port_number": 7657
29      },
1030      "http_proxy_port": {"bind_mode": "published", "port_number": 4444},
1131      "https_proxy_port": {
32        "bind_mode": "published",
33        "port_number": 4445
34      }
35    },
1236    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
37  }
38}

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 i2p 1.1.12”.

    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 7657, 4444 and 4445 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) › i2p and App storage (fast) › i2p › i2p_config. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–20

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

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

    Line 23

  9. Router console port: 7657

    Publishes the app's router console port as 7657.

    Lines 26–29

  10. Http proxy port: 4444

    Publishes the app's http proxy port as 4444.

    Line 30

  11. Https proxy port: 4445

    Publishes the app's https proxy port as 4445.

    Lines 31–34

  12. 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 36