lunar-mining 2 anni fa
parent
commit
04780f241b
1 ha cambiato i file con 39 aggiunte e 0 eliminazioni
  1. 39 0
      bin/dnet/README.md

+ 39 - 0
bin/dnet/README.md

@@ -0,0 +1,39 @@
+# dnet
+
+A simple tui to explore darkfi p2p network topology. Displays:
+
+1. Active p2p nodes
+2. Outgoing, incoming, manual and seed sessions
+3. Each associated connection and recent messages.
+
+`dnet` is based on the design-pattern Model, View, Controller. We create
+a logical seperation between the underlying data structure or Model;
+the ui rendering aspect which is the View; and the Controller or game
+engine that makes everything run.
+
+## Run
+
+```shell
+% git clone https://github.com/darkrenaissance/darkfi 
+% cd darkfi/bin/dnet
+% python main.py
+```
+
+Navigate up and down using the arrow keys. Type `q` to quit.
+
+## Usage
+
+The `dnet` config file can be found in `bin/dnet/config.toml`. You must
+enter the RPC ports of the nodes you want to connect to and title them as
+you see fit. You must also specify whether it is a `NORMAL` or a `LILITH`
+node. The default config file uses localhost, but you can replace this
+with hostnames or external IP addresses.
+
+## Logging
+
+dnet creates a log file in `bin/dnet/dnet.log`. To see json data and
+other debug info, tail the file like so:
+
+```shell
+tail -f dnet.log
+```