|
|
@@ -3,7 +3,17 @@
|
|
|
This is a local daemon which can be attached to with any IRC frontend.
|
|
|
It uses the darkfi p2p engine to synchronize chats between hosts.
|
|
|
|
|
|
-## Local Deployment
|
|
|
+
|
|
|
+## Install
|
|
|
+
|
|
|
+```shell
|
|
|
+% git clone https://github.com/darkrenaissance/darkfi
|
|
|
+% cd darkfi
|
|
|
+% make BINS=ircd
|
|
|
+% make install BINS=ircd PREFIX=/home/XX/.local
|
|
|
+```
|
|
|
+
|
|
|
+## Usage (Local Deployment)
|
|
|
|
|
|
### Seed Node
|
|
|
|
|
|
@@ -12,9 +22,12 @@ connect to when they first connect to the network. The `seed_session` simply
|
|
|
connects to a seed node and runs `protocol_seed`, which requests a list of
|
|
|
addresses from the seed node and disconnects straight after receiving them.
|
|
|
|
|
|
- LOG_TARGETS=net cargo run -- -vv --accept 0.0.0.0:9999 --irc 127.0.0.1:6688
|
|
|
+ in config file:
|
|
|
+
|
|
|
+ ## P2P accept address
|
|
|
+ inbound="127.0.0.1:11001"
|
|
|
|
|
|
-Note that the above command doesn't specify an external address since the
|
|
|
+Note that the above config doesn't specify an external address since the
|
|
|
seed node shouldn't be advertised in the list of connectable nodes. The seed
|
|
|
node does not participate as a normal node in the p2p network. It simply allows
|
|
|
new nodes to discover other nodes in the network during the bootstrapping phase.
|
|
|
@@ -26,7 +39,16 @@ making any outbound connections.
|
|
|
|
|
|
The external address is important and must be correct.
|
|
|
|
|
|
- LOG_TARGETS=net cargo run -- -vv --accept 0.0.0.0:11004 --external $LOCAL_IP:11004 --seeds $SEED_IP:9999 --irc 127.0.0.1:6667
|
|
|
+ in config file:
|
|
|
+
|
|
|
+ ## P2P accept address
|
|
|
+ inbound="127.0.0.1:11002"
|
|
|
+
|
|
|
+ ## P2P external address
|
|
|
+ external_addr="127.0.0.1:11002"
|
|
|
+
|
|
|
+ ## Seed nodes to connect to
|
|
|
+ seeds=["127.0.0.1:11001"]
|
|
|
|
|
|
### Outbound Node
|
|
|
|
|
|
@@ -34,7 +56,13 @@ This is a node which has 8 outbound connection slots and no inbound connections.
|
|
|
This means the node has 8 slots which will actively search for unique nodes to
|
|
|
connect to in the p2p network.
|
|
|
|
|
|
- LOG_TARGETS=net cargo run -- -vv --slots 5 --seeds $SEED_IP:9999 --irc 127.0.0.1:6668
|
|
|
+ in config file:
|
|
|
+
|
|
|
+ ## Connection slots
|
|
|
+ outbound_connections=5
|
|
|
+
|
|
|
+ ## Seed nodes to connect to
|
|
|
+ seeds=["127.0.0.1:11001"]
|
|
|
|
|
|
### Attaching the IRC Frontend
|
|
|
|