Skip to content

Commit

Permalink
update env-example and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lalanza808 committed Dec 30, 2024
1 parent cd6e671 commit 96aa22c
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# docker-monero-node

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

* [monero-exporter](https://github.com/cirocosta/monero-exporter) - exposes metrics of the daemon
* [nodemapper](./dockerfiles/nodemapper.py) - gathers GeoIP data for peers
* [Prometheus](https://prometheus.io/docs/introduction/overview/) - monitors the exporter
* [Grafana](https://grafana.com/) - shows visualizations and dashboards
* [tor](https://www.torproject.org/) - provides tx relays over tor proxy
* [i2pd](https://i2pd.website/) - provides tx relays over i2p proxy

Leverages [Prometheus](https://prometheus.io/docs/introduction/overview/), [Grafana](https://grafana.com/), [nodemapper](./dockerfiles/nodemapper.py), and [monero-exporter](https://github.com/cirocosta/monero-exporter) on top of `monerod`.

## Setup

Expand All @@ -19,6 +25,9 @@ vim .env
# Build containers
docker-compose build # make build
# Run containers
docker-compose up -d # make up
```

The following ports will be bound for `monerod` by default, but you can override in `.env`:
Expand All @@ -32,10 +41,15 @@ The following ports are commented out but can be enabled to test things locally:
- 3000 # grafana web ui
- 9000 # exporter web api (/metrics)
- 5000 # nodemapper web api (/metrics)
- 9050 # tor proxy
- 4444 # i2p http proxy
- 4447 # i2p socks proxy

There are two hard-coded IP addresses for the tor and i2p proxies (monerod requires an IP address for setting the `--tx-proxy` flag.) You will need to modify your compose file if you need to adjust them.

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!
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! You can find a live example on my node here: https://singapore.node.xmr.pm

## Usage

Expand Down
10 changes: 7 additions & 3 deletions env-example
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
DATA_DIR=/opt/monero/data
GRAFANA_URL=http://mynodeurl.com
DATA_DIR=./data
P2P_PORT=18080
RESTRICTED_PORT=18081
ZMQ_PORT=18082
UNRESTRICTED_PORT=18083
PROM_RETENTION=360d
PROM_TAG=v2.36.0
GRAFANA_URL=http://mynodeurl.com
GRAFANA_TAG=10.1.4
GRAF_PORT=3000
GF_AUTH_ANONYMOUS_ENABLED=true
GF_AUTH_BASIC_ENABLED=true
GF_AUTH_DISABLE_LOGIN_FORM=false
GF_SECURITY_ADMIN_PASSWORD=admin
GF_SECURITY_ADMIN_USER=admin
GF_INSTALL_PLUGINS=
GF_SERVER_SERVE_FROM_SUB_PATH=false
GF_SERVER_SERVE_FROM_SUB_PATH=false

0 comments on commit 96aa22c

Please sign in to comment.