xmr-remote-nodes/README.md
ditatompel 5fae3d565a
chore: Rename tools directory to deployment
The `tools` directory contains example ansible playbook, systemd
example, and Nginx configuration example for the server.

The directory name `deployment` for that stuffs much more suitable.
2024-05-30 12:02:11 +07:00

1.4 KiB

XMR Remote Nodes

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

Requirements

Server & Prober requirements

  • Go >= 1.22
  • Linux Machines (AMD64 or ARM64)

Server requirements

Installation

For initial server setup:

  1. Download GeoIP Database and place it to ./assets/geoip. (see ./internal/geo/ip.go).
  2. Copy .env.example to .env and edit it to match with server environment.
  3. Build the binary with make build.
  4. Run the service with ./bin/xmr-nodes-server-linux-<YOUR_CPU_ARCH> serve.

Systemd example: ./deployment/init/xmr-nodes-server.service.

For initial prober setup:

  1. Create API key for prober
  2. Copy .env.example to .env and edit it to match with prober environment.
  3. Build the binary with make build.
  4. Run the service with ./bin/xmr-nodes-client-linux-<YOUR_CPU_ARCH> probe.

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