diff --git a/wownero/README.md b/wownero/README.md index da0bd69..864cd68 100644 --- a/wownero/README.md +++ b/wownero/README.md @@ -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 . diff --git a/wownero/files/static/wownerod-grafana.png b/wownero/files/static/wownerod-grafana.png new file mode 100644 index 0000000..79b4b26 Binary files /dev/null and b/wownero/files/static/wownerod-grafana.png differ