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

Updated README: replaced URL and contact

This commit is contained in:
Dmitri Bogomolov 2021-03-10 23:27:46 +02:00
parent e77f59154c
commit 20d2e919d9
Signed by untrusted user: g1itch
GPG Key ID: 720A756F18DEED13
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,5 +1,6 @@
# MiNode
Python 3 implementation of the Bitmessage protocol. Designed only to route objects inside the network.
Python 3 implementation of the Bitmessage protocol. Designed only to route
objects inside the network.
## Requirements
- python3 (or pypy3)
@ -7,16 +8,16 @@ Python 3 implementation of the Bitmessage protocol. Designed only to route objec
## Running
```
git clone https://github.com/TheKysek/MiNode.git
git clone https://github.com/g1itch/MiNode.git
```
```
cd MiNode
chmod +x start.sh
./start.sh
```
It is worth noting that the `start.sh` file MiNode no longer tries to do a `git pull` in order to update to the latest version.
Is is now done by the `update.sh` file.
It is worth noting that the `start.sh` script no longer tries to do a
`git pull` in order to update to the latest version.
Is is now done by the `update.sh` script.
## Command line
```
@ -49,17 +50,22 @@ optional arguments:
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.
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 3 (default is 2).
Connect to both IP and I2P networks (SAM bridge on default host and port
127.0.0.1:7656) and set tunnel length to 3 (default is 2).
```
$ ./start.sh --i2p --i2p-tunnel-length 3
```
Connect only to I2P network and listen for IP connections only from local machine.
Connect only to I2P network and listen for IP connections only from local
machine.
```
$ ./start.sh --i2p --no-ip --host 127.0.0.1
```
@ -67,9 +73,11 @@ 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.
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
- TheKysek: BM-2cVUMXVnQXmTJDmb7q1HUyEqkT92qjwGvJ
- g1itch: BM-NC4h7r3HGcJgqNuwSEpGcSiVij3BKuXa
## Links
- [Bitmessage project website](https://bitmessage.org)