add more instructions to the readme and include a cool image

This commit is contained in:
lza_menace 2020-10-29 15:14:59 -07:00
parent f4fd3661fb
commit 4ea1291dab
2 changed files with 26 additions and 0 deletions

View file

@ -2,6 +2,32 @@
Container image for the official Wownero source code compiled to provide daemon, wallet CLI, and wallet RPC binaries.
## Instructions
Pre-requisites:
* Recent Ubuntu Linux
* `sudo apt-get install docker.io docker-compose`
* `sudo usermod -aG docker $(whoami); logout`
## Node-in-a-box
The simplest way to get started is to use docker-compose and turn up the provided packages, including the Wownero daemon, monitoring tools, and a visualization/graphing tool.
```
cd wownero/ # in this folder
docker-compose up -d
# wownerod available at ports 34567 and 34568
```
You can host the node on an official DNS endpoint for public usage or keep it local for your own private usage.
![](files/static/wownerod-grafana.png)
## Manual Daemon and Wallet Setup
The node and wallet software is in the same package, so both can be used from within the Docker container.
```
# build container image of wownero binaries
docker build -t wownero .

Binary file not shown.

After

Width:  |  Height:  |  Size: 716 KiB