Git Product home page Git Product logo

docker-monero-node's Introduction

docker-monero-node

Simple way to run a Monero node with some basic monitoring tools packaged in.

Leverages Prometheus, Grafana, nodemapper, and monero-exporter on top of monerod.

Setup

The only requirements are Docker and Docker Compose. 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

# OPTIONAL: Setup Grafana password, blockchain storage location, or port and container image tag overrides
cp env-example .env
vim .env

# Build containers
docker-compose build  # make build

The following ports will be bound for monerod by default, but you can override in .env:

  • 18080 # p2p
  • 18081 # restricted rpc
  • 18082 # zmq
  • 18083 # unrestricted rpc

The following ports are commented out but can be enabled to test things locally:

  • 9090 # prometheus web ui
  • 3000 # grafana web ui
  • 9000 # exporter web api (/metrics)
  • 5000 # nodemapper web api (/metrics)

You will want to open/allow ports 18080 and 18081 in your firewall for usage as a remote/public node (or whichever p2p and restricted ports you picked).

Also, you may want to setup a reverse proxy to Grafana if you would like to expose the visualizations for the world to see. Be sure to lock down the administrative settings or leave login disabled!

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  

# Check monerod logs
docker-compose logs -f monerod  # make logs

Navigate to http://localhost:3000 and log into Grafana. Find the Node Stats dashboard to get those sweet, sweet graphs.

If you've installed this on another system you will want to use SSH tunnels (local forwarding) to reach Grafana (if not exposing via reverse proxy):

ssh <VPS OR SERVER IP> -L 3000:localhost:3000

Then navigate to http://localhost:3000. Here is what the graph looks like:

docker-monero-node's People

Contributors

lalanza808 avatar jahway603 avatar imcdona avatar monerobull avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.