diff --git a/Makefile b/Makefile index 31b52b0..34f9d65 100644 --- a/Makefile +++ b/Makefile @@ -12,6 +12,12 @@ up: ## Build and run the required containers by fetching binaries up-full: ## Build and run the required containers by compiling source docker-compose -f docker-compose.full.yaml up -d +build: ## Build the required containers by fetching binaries + docker-compose -f docker-compose.yaml build --no-cache + +build-full: ## Build the required containers by compiling source + docker-compose -f docker-compose.full.yaml build --no-cache + down: ## Stop the containers docker-compose -f docker-compose.yaml down diff --git a/README.md b/README.md index 511c697..300eacd 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,49 @@ # docker-monero-node -Simple way to run a Monero daemon with some basic monitoring tools packaged in. +Simple way to run a Monero node with some basic monitoring tools packaged in. + +Leverages Prometheus, Grafana, and [ExcitableAardvark/monerod_exporter](https://github.com/ExcitableAardvark/monerod_exporter.git) on top of `monerod`. ## Setup -The only requirements are [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/). Ensure those are installed on your system. +The only requirements are [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/). Ensure those are installed on your system. There's an optional `Makefile` provided if you'd like to use that, just ensure `make` is installed. ``` # Clone and enter the repository git clone https://github.com/lalanza808/docker-monero-node cd docker-monero-node -# Setup Grafana password and blockchain storage location +# OPTIONAL: Setup Grafana password and blockchain storage location cp env-example .env vim .env -# Start containers -docker-compose up -d +# Build containers +docker-compose build # make build +``` + +## Usage + +It's fairly simple, use `docker-compose` to bring the containers up and down and look at logs. + +``` +# Run containers +docker-compose up -d # make up + +# Check all logs +docker-compose logs -f # make logs + +# Check monerod logs +docker-compose logs -f monerod ``` Navigate to http://localhost:3000 and log into Grafana. Find the `Daemon Stats` dashboard to get those sweet, sweet graphs. + +If you've installed this on another system you will want to use [SSH tunnels](https://www.ssh.com/ssh/tunneling/example) (local forwarding) to reach Grafana: + +``` +ssh -L 3000:localhost:3000 +``` + +Then navigate to http://localhost:3000. Here is what the graph looks like: + +![](static/monerod_grafana.png) diff --git a/static/monerod_grafana.png b/static/monerod_grafana.png new file mode 100644 index 0000000..c20e347 Binary files /dev/null and b/static/monerod_grafana.png differ