Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mudler committed Oct 29, 2021
1 parent 9e4fe87 commit 1e670fe
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ EdgeVPN uses libp2p to build an immutable trusted blockchain addressable p2p net

It connect and creates a small blockchain between nodes. It keeps the routing table stored in the ledger, while connections are dynamically established via p2p.


## Screenshots

Connected machines | Blockchain index
:-------------------------:|:-------------------------:
![edgevpn1](https://user-images.githubusercontent.com/2420543/139510781-18bc083e-34db-4b9c-b9ea-6250979d61cc.png)| ![edgevpn2](https://user-images.githubusercontent.com/2420543/139510466-b8518d78-57c9-4325-b365-6439a8d130c3.png)

## Usage

Generate a config, and send it over all the nodes you wish to connect:
Expand Down Expand Up @@ -37,6 +44,28 @@ IFACE=edgevpn0 ADDRESS=10.1.0.13/24 ./edgevpn

*Note*: It might take up time to build the connection between nodes. Wait at least 5 mins, it depends on the network behind the hosts.

## Web interface

To access the web interface, run

```bash
edgevpn api
```

with the same `EDGEVPNCONFIG` or `EDGEVPNTOKEN`. It will connect to the network without routing any packet.

By default edgevpn will listen on the `8080` port. See `edgevpn api --help` for the available options

### API endpoint

#### `/api/data`

Returns the latest available data stored in the blockchain

#### `/api/blockchain`

Returns the latest available blockchain

## Architecture

- Simple (KISS) interface to display network data from the blockchain
Expand Down

0 comments on commit 1e670fe

Please sign in to comment.