|
@@ -1,19 +1,17 @@
|
|
|
-# dnetview
|
|
|
|
|
|
|
+# Dnetview
|
|
|
|
|
|
|
|
-A simple tui to explore darkfi ircd network topology.
|
|
|
|
|
|
|
+A simple tui to explore darkfi p2p network topology. Explore:
|
|
|
|
|
|
|
|
-dnetview displays:
|
|
|
|
|
|
|
+1. Active p2p nodes
|
|
|
|
|
+2. Outgoing, incoming and manual sessions
|
|
|
|
|
+3. Each associated connection and recent messages.
|
|
|
|
|
|
|
|
-1. all active nodes
|
|
|
|
|
-2. outgoing, incoming and manual sessions
|
|
|
|
|
-3. each associated connection and recent messages.
|
|
|
|
|
-
|
|
|
|
|
-dnetview is based on the design-pattern Model, View, Controller. We
|
|
|
|
|
|
|
+Dnetview is based on the design-pattern Model, View, Controller. We
|
|
|
create a logical seperation between the underlying data structure or
|
|
create a logical seperation between the underlying data structure or
|
|
|
Model; the ui rendering aspect which is the View; and the Controller or
|
|
Model; the ui rendering aspect which is the View; and the Controller or
|
|
|
game engine that makes everything run.
|
|
game engine that makes everything run.
|
|
|
|
|
|
|
|
-## install
|
|
|
|
|
|
|
+## Install
|
|
|
|
|
|
|
|
```shell
|
|
```shell
|
|
|
% git clone https://github.com/darkrenaissance/darkfi
|
|
% git clone https://github.com/darkrenaissance/darkfi
|
|
@@ -21,7 +19,7 @@ game engine that makes everything run.
|
|
|
% make BINS=dnetview
|
|
% make BINS=dnetview
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-## usage
|
|
|
|
|
|
|
+## Usage
|
|
|
|
|
|
|
|
On first run, dnetview will create a config file in .config/darkfi. You
|
|
On first run, dnetview will create a config file in .config/darkfi. You
|
|
|
must manually enter the RPC ports of the nodes you want to connect to
|
|
must manually enter the RPC ports of the nodes you want to connect to
|
|
@@ -37,6 +35,8 @@ dnetview -v
|
|
|
|
|
|
|
|
Navigate up and down using `j` and `k`.
|
|
Navigate up and down using `j` and `k`.
|
|
|
|
|
|
|
|
|
|
+## Logging
|
|
|
|
|
+
|
|
|
Dnetview creates a logging file in /tmp/dnetview.log. To see json data
|
|
Dnetview creates a logging file in /tmp/dnetview.log. To see json data
|
|
|
and other debug info, tail the file like so:
|
|
and other debug info, tail the file like so:
|
|
|
|
|
|