dandri/mycelium
1
0 Fork 0
mirror of https://github.com/threefoldtech/mycelium.git synced 2026-10-23 14:02:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Correct the peers parameter in the readme example

Browse Source
This commit is contained in:
Rob Van Mieghem committed 2023-08-09 15:35:23 +02:00
1 parent f77f353d75
commit 9d97ecd18c
1 file changed
+4 -4
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -4
View File
@@ -1,21 +1,21 @@
# Mycelium
This POC aims to create an IPv6 overlay network completely writing in Rust. The overlay network uses some of the core principles
of the Babel routing protocol (https://www.irif.fr/~jch/software/babel/). Each node that joins the overlay network will receive
an overlay network IP in the 200::/7 range.
of the Babel routing protocol (<https://www.irif.fr/~jch/software/babel/>). Each node that joins the overlay network will receive
an overlay network IP in the 200::/7 range.
## Running
> Currently, only Linux is supported.
First, get an useable binary, either by downloading [an artifact from a release](https://github.com/threefoldtech/mycelium/releases),
or by [checking out and building the code yourself](#Developing).
or by [checking out and building the code yourself](#developing).
Once you have an useable binary, simply start it. If you want to connect to other nodes, you can specify their listening address as
part of the command
```sh
mycelium -peers 203.0.113.5:9651
mycelium --peers 203.0.113.5:9651
```
By default, the node will listen on port `9651`, though this can be overwritten with the `-p` flag.