Add i2p support (#19)

* Add i2p support

Author: evehash

.env.example

@@ -7,13 +7,24 @@ SHARED_GID=1099
 # Example: tor-0.4.8.10
 TOR_VERSION=0.4.8.13
 
-# User identifier used for tor inside the container
+# User identifier used for tor inside the container.
 TOR_USER_ID=1099
 
 # Directory on the host machine where to moutn the data volume for tor
 TOR_DATA=./volumes/tor
 
-# Bitcoin core version and platform to build the container.
+# i2p version to build the container.
+# To be obtained from this site: https://github.com/i2p/i2p.i2p/releases
+# Example: i2p-2.7.0
+I2P_VERSION=2.7.0
+
+# User identifier used for i2p inside the container.
+I2P_USER_ID=1000
+
+# Directory on the local machine where to mount the data volume for i2p
+I2P_DATA=./volumes/i2p
+
+# Bitcoin core version to build the container.
 # To be obtained from this site: https://github.com/bitcoin/bitcoin/releases
 # Example: bitcoin-v26.0
 BITCOIN_VERSION=28.1

.github/workflows/build.yml

@@ -9,7 +9,9 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
-      - name: Build images
+      - name: Build default images
         run: docker compose --env-file .env.example build
+      - name: Build disabled images
+        run: docker compose --env-file .env.example --profile disabled build
       - name: List images
         run: docker images

GETTING_STARTED.md

@@ -12,6 +12,7 @@
 - <a href="#using-your-node">Using your node</a>
 - <a href="#post-installation">Post-installation</a>
 - <a href="#remote-access-to-your-node-via-tor-optional">Remote access to your node via tor (Optional)</a>
+- <a href="#add-i2p-as-an-additional-network-optional">Add i2p as an additional network (Optional)</a>
 
 ## Prerequisites
 
@@ -122,6 +123,8 @@ $ docker logs -f 06a96296854a
 # [notice] Bootstrapped 100% (done): Done
 ```
 
+
+
 ### bitcoind
 
 The bitcoind configuration file is located in `/mnt/hdd/bitcoind/bitcoin.conf`. The default parameters are enough, except for one that depends on the memory of your local machine and the default password for communication between services, which you should generate yourself for security reasons.
@@ -317,3 +320,26 @@ $ cat btc-rpc-explorer/hostname
 ```
 
 To revert this configuration, comment the lines again, and restart tor.
+
+## Add i2p as an additional network (Optional)
+
+I2P (Invisible Internet Project) is a decentralized network designed for anonymous communication, complementing Tor by offering additional censorship resistance protection. Combining I2P with Tor in a Bitcoin node enhances privacy, decentralization, and connectivity to privacy-focused peers while mitigating Eclipse attacks, as the node does not connect to the clearnet by default, making isolation by malicious actors significantly harder.
+
+I2P adds extra complexity to node setup and is disabled by default, allowing advanced users to enable it if needed.
+
+If you want to enable it, uncomment the following lines in the I2P service of the `docker-compose` file.
+
+```conf
+profiles:
+  - disabled
+```
+
+When the service is up and running, follow these steps:
+
+ - Open the web page: http://your_node_ip:7657 and follow the wizard (just click "Next" for all steps, using the default settings).
+ - Go to the Client tab.
+ - Enable Run at Startup? for the SAMBridge client and save.
+ - Click "Start" for the SAMBridge to activate it immediately.
+ - After the SAMBridge starts, ensure the configuration is properly saved and the service is running.
+
+Finally, edit the bitcoin.conf file, uncomment the lines related to I2P, and restart the node.

README.md

@@ -35,6 +35,7 @@ The following services are deployed:
 | <a href="https://github.com/romanz/electrs">Electrs</a>                         | 0.10.8       | debian:stable-slim | 80.7 MB |
 | <a href="https://github.com/janoside/btc-rpc-explorer">Bitcoin RPC Explorer</a> | 3.4.0        | node:22-slim       | 377 MB  |
 | <a href="https://github.com/nginxinc/docker-nginx">NGINX</a>                    | stable-slim  | nginx:alpine-slim  | 11.5 MB |
+| <a href="https://github.com/i2p/i2p.i2p">i2p</a> (optional)                     | 2.7.0        | debian:stable-slim | 222 MB  |
 
 ## Documentation
 

docker-compose.yml

@@ -13,6 +13,26 @@ services:
     networks:
       default:
         ipv4_address: 172.18.0.2
+  i2p:
+    image: i2p:$I2P_VERSION
+    profiles:
+      - disabled
+    build:
+      context: ./i2p
+      args:
+        - I2P_VERSION=$I2P_VERSION
+        - I2P_USER_ID=$I2P_USER_ID
+        - GROUP_ID=$SHARED_GID
+    volumes:
+      - $I2P_DATA:/i2p/.i2p
+    environment:
+      - EXT_PORT:7656
+    ports:
+      - 7657:7657
+    restart: on-failure
+    networks:
+      default:
+        ipv4_address: 172.18.0.3
   bitcoind:
     image: bitcoind:$BITCOIN_VERSION
     depends_on:
@@ -28,7 +48,7 @@ services:
     restart: unless-stopped
     networks:
       default:
-        ipv4_address: 172.18.0.3
+        ipv4_address: 172.18.0.4
   electrs:
     image: electrs:$ELECTRS_VERSION
     depends_on:
@@ -45,7 +65,7 @@ services:
     restart: on-failure
     networks:
       default:
-        ipv4_address: 172.18.0.4
+        ipv4_address: 172.18.0.5
   btcrpcexplorer:
     image: btcrpcexplorer:$BTC_RPC_EXPLORER_VERSION
     depends_on:
@@ -62,7 +82,7 @@ services:
     restart: on-failure
     networks:
       default:
-        ipv4_address: 172.18.0.5
+        ipv4_address: 172.18.0.6
   nginx:
     image: nginx:alpine-slim
     depends_on:
@@ -76,7 +96,7 @@ services:
     restart: on-failure
     networks:
       default:
-        ipv4_address: 172.18.0.6
+        ipv4_address: 172.18.0.7
 
 networks:
   default:

i2p/Dockerfile

@@ -0,0 +1,28 @@
+FROM alpine:latest AS build
+ARG I2P_VERSION
+RUN apk add --update --no-cache apache-ant bzip2 gettext gpg gpg-agent wget \
+  && cd /opt \
+  && wget https://github.com/i2p/i2p.i2p/releases/download/i2p-${I2P_VERSION}/i2psource_${I2P_VERSION}.tar.bz2 \
+  && wget https://github.com/i2p/i2p.i2p/releases/download/i2p-${I2P_VERSION}/i2psource_${I2P_VERSION}.tar.bz2.sig \
+  && wget -O - https://geti2p.net/_static/idk.key.asc | gpg --import \
+  && gpg --verify i2psource_${I2P_VERSION}.tar.bz2.sig \
+  && tar -xvf i2psource_${I2P_VERSION}.tar.bz2 \
+  && cd i2p-${I2P_VERSION} \
+  && ant preppkg-linux-only \
+  && apk del apache-ant bzip2 gettext gpg gpg-agent wget
+
+
+FROM alpine:latest
+ARG I2P_USER_ID
+ARG I2P_VERSION
+ARG GROUP_ID
+COPY --from=build /opt/i2p-${I2P_VERSION}/pkg-temp /i2p
+COPY --from=build /opt/i2p-${I2P_VERSION}/docker/rootfs/ /
+RUN apk add --update --no-cache openjdk17-jre-headless \
+  && addgroup --gid ${GROUP_ID} i2p \
+  && adduser -u ${I2P_USER_ID} --disabled-password --gecos "" --ingroup i2p i2p \
+  && chmod +x /startapp.sh
+
+USER i2p
+
+CMD /startapp.sh

volumes/bitcoind/bitcoin.conf

@@ -17,6 +17,11 @@ onlynet=onion
 # Since the preference dns=0, we have to reference "tor" by IP
 proxy=172.18.0.2:9050
 
+# i2p - Uncomment when i2p is configured. There can be several onlynet in this file.
+# onlynet=i2p
+# i2psam=172.18.0.3:7656
+# 
+
 # When the configuration specifies that śonly tor be used, the node has problems discovering the first nodes
 addnode=akvbwwzxuylqefaaxtsvieordjb3invsercadlwseswhii3hjis7vryd.onion
 addnode=bitcoinlpnavvcmyviet6vjfdkeive5yolewi4teudtywhbsqxcqtxid.onion