Просмотр исходного кода

ircd, tau: update README.md & change install instructions

ghassmo 4 лет назад
Родитель
Сommit
78522e1de8
2 измененных файлов с 88 добавлено и 11 удалено
  1. 33 5
      bin/ircd/README.md
  2. 55 6
      bin/tau/README.md

+ 33 - 5
bin/ircd/README.md

@@ -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
 

+ 55 - 6
bin/tau/README.md

@@ -1,5 +1,3 @@
-
-
 # Tau
 
 Tasks management app using peer-to-peer network and raft consensus.  
@@ -10,12 +8,63 @@ multiple users can collaborate by working on the same tasks, and all users will
 
 ```shell
 % git clone https://github.com/darkrenaissance/darkfi 
-% cd darkfi/bin/tau
-% make 
-% make install  
+% cd darkfi
+% make BINS="taud tau"
+% make install "BINS=taud tau" PREFIX=/home/XX/.local
 ```
 
-## Usage
+## Usage (Local Deployment)
+
+### Seed Node
+
+First you must run a seed node. The seed node is a static host which nodes can
+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.
+
+	in config file:
+
+		## P2P accept address
+		inbound="127.0.0.1:11001" 
+
+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.
+
+### Inbound Node
+
+This is a node accepting inbound connections on the network but which is not
+making any outbound connections.
+
+The external address is important and must be correct.
+
+	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
+
+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.
+
+	in config file:
+
+		## Connection slots
+		outbound_connections=5
+
+		## Seed nodes to connect to 
+		seeds=["127.0.0.1:11001"]
+
+## Usage (CLI)
 
 ```shell
 % tau --help