Bitmessage/MiNode
3
0
Fork 1
Code Pull Requests 10 Actions Activity

Update README

Browse Source
This commit is contained in:
TheKysek 2017-07-01 15:58:31 +02:00
parent 057b25a812
commit 37c144641f
No known key found for this signature in database
GPG Key ID: 50D9AF00D0B1C497
1 changed files with 34 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -20,23 +20,54 @@ Is is now done by the `update.sh` file.
## Command line ## Command line
``` ```
usage: main.py [-h] [-p PORT] [--debug] [--data-dir DATA_DIR] [--no-incoming] usage: main.py [-h] [-p PORT] [--host HOST] [--debug] [--data-dir DATA_DIR]
[--no-outgoing] [--trusted-peer TRUSTED_PEER] [--no-incoming] [--no-outgoing] [--no-ip]
[--connection-limit CONNECTION_LIMIT] [--trusted-peer TRUSTED_PEER]
[--connection-limit CONNECTION_LIMIT] [--i2p]
[--i2p-tunnel-length I2P_TUNNEL_LENGTH]
[--i2p-sam-host I2P_SAM_HOST] [--i2p-sam-port I2P_SAM_PORT]
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
-p PORT, --port PORT Port to listen on -p PORT, --port PORT Port to listen on
--host HOST Listening host
--debug Enable debug logging --debug Enable debug logging
--data-dir DATA_DIR Path to data directory --data-dir DATA_DIR Path to data directory
--no-incoming Do not listen for incoming connections --no-incoming Do not listen for incoming connections
--no-outgoing Do not send outgoing connections --no-outgoing Do not send outgoing connections
--no-ip Do not use IP network
--trusted-peer TRUSTED_PEER --trusted-peer TRUSTED_PEER
Specify a trusted peer we should connect to Specify a trusted peer we should connect to
--connection-limit CONNECTION_LIMIT --connection-limit CONNECTION_LIMIT
Maximum number of connections Maximum number of connections
--i2p Enable I2P support (uses SAMv3)
--i2p-tunnel-length I2P_TUNNEL_LENGTH
Length of I2P tunnels
--i2p-sam-host I2P_SAM_HOST
Host of I2P SAMv3 bridge
--i2p-sam-port I2P_SAM_PORT
Port of I2P SAMv3 bridge
```
## I2P support
MiNode has support for connections over I2P network.
To use it it needs an I2P router with SAMv3 activated (both Java I2P and i2pd are supported).
Keep in mind that I2P connections are slow and full synchronization may take a while.
### Examples
Connect to both IP and I2P networks (SAM bridge on default host and port 127.0.0.1:7656) and set tunnel length to 2 (default is 3).
```
$ ./start.sh --i2p --i2p-tunnel-length 2
``` ```
Connect only to I2P network and listen for IP connections only from local machine.
```
$ ./start.sh --i2p --no-ip --host 127.0.0.1
```
or
```
$ ./i2p_bridge.sh
```
If you add `trustedpeer = 127.0.0.1:8444` to `keys.dat` file in PyBitmessage it will allow you to use it anonymously over I2P with MiNode acting as a bridge.
## Contact ## Contact
- TheKysek: BM-2cVUMXVnQXmTJDmb7q1HUyEqkT92qjwGvJ - TheKysek: BM-2cVUMXVnQXmTJDmb7q1HUyEqkT92qjwGvJ