XMR Remote Nodes

Source code of https://xmr.ditatompel.com, a website that helps you monitor your favourite Monero remote nodes.

⚠️ 🚧 This project is not mature enough 🚧, If you want to use it on your server, please use it with caution.

How does it work?

Apart from CPU architecture type, you can build two types of binaries from this project: a server and a client.

The clients is used to fetch node information given by the server. First, it will ask the server which node to fetch. Then, it will fetch the information and report back to the server.

The server serves an embedded Svelte static site for the Web UI. It also serves the /api endpoint that is used by the clients and the Web UI itself.

Requirements

To build the executable binaries, you need:

Go >= 1.22
NodeJS >= 20

Server & Prober requirements

Linux Machines (AMD64 or ARM64)

Server requirements

MySQL/MariaDB
GeoIP Database (optional). Place it to ./assets/geoip, see ./internal/geo/ip.go.

Installation

For initial server setup:

Download GeoIP Database and place it to ./assets/geoip. (see ./internal/geo/ip.go).
Pepare your MySQL/MariaDB.
Copy .env.example to .env and edit it to match with server environment.
Build the binary with make server (or make build to build both server and client binaries).
Run the service with ./bin/xmr-nodes-server-linux-<YOUR_CPU_ARCH> serve.

Systemd example: xmr-nodes-server.service.

For initial prober setup:

Create API key for prober
Copy .env.example to .env and edit it to match with prober environment.
Build the binary with make client (or make build to build both server and client binaries).
Run the service with ./bin/xmr-nodes-client-linux-<YOUR_CPU_ARCH> probe.

Systemd example: xmr-nodes-prober.service and xmr-nodes-prober.timer.

Development and Deployment

See the Makefile.

ToDo's

Accept IPv6 nodes.
Use a-h/templ and HTMX instead of Svelte.
Use Go standard net/http instead of fiber.

Similar Projects

License

This project is licensed under GLWTPL.

3.7 KiB Raw Blame History