Ecosystem/xmr-remote-nodes
1
0
Fork 0
mirror of https://github.com/ditatompel/xmr-remote-nodes.git synced 2024-12-22 19:49:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
xmr-remote-nodes/README.md
Christian Ditaputratama 15804ee438
Some checks failed
Build / build (push) Waiting to run
Details
Test / test (push) Has been cancelled
Details
chore: Update readme: Still show old license 
Also mark migrating from Stelte to Templ + HTMX done in ToDo's section
2024-11-07 04:40:59 +07:00

5 KiB
Raw Blame History

XMR Remote Nodes

Test BUild Release Binaries Go Report Card

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
  • Bun >= 1.1.26
  • templ v0.2.778

Note

:

  • If you want to contribute to the code, please use exact templ version (v0.2.778).

Server & Prober requirements

  • Linux Machines (AMD64 or ARM64)

Server requirements

Installation

For initial server setup:

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

Systemd example: 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 client (or make build to build both server and client binaries).
  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.

Development and Deployment

  1. Clone or fork this repository.
  2. Prepare the assets: make prepare,
  3. Run air serve (live reload using air-verse/air).

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.

Acknowledgement

The creators and contributors of these projects have provided valuable resources, which I am grateful for:

Similar Projects

Donation

The servers costs are currently covered by myself. If you find this project useful, please consider making a donation to help cover the ongoing expenses. Your contribution will go towards ensuring the continued availability of the website and my stagenet and testnet public remote nodes.

XMR Donation address:

8BWYe6GzbNKbxe3D8mPkfFMQA2rViaZJFhWShhZTjJCNG6EZHkXRZCKHiuKmwwe4DXDYF8KKcbGkvNYaiRG3sNt7JhnVp7D

Thank you!

License

This project is licensed under BSD-3-Clause license.