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
Source code of https://xmr.ditatompel.com, a website that helps you monitor your favourite Monero remote nodes.
179 commits 3 branches 10 tags 10 MiB
Go 61%
templ 32.6%
Makefile 2.2%
CSS 1.9%
Nginx 1.5%
Other 0.8%
Find a file
ditatompel acf99a3ca8
chore(ci): Release action (test)
2024-06-11 01:38:30 +07:00
.github chore(ci): Release action (test) 2024-06-11 01:38:30 +07:00
cmd Lowercase & upperase initialism acronyms 2024-06-10 03:03:23 +07:00
deployment chore: Rename tools directory to deployment 2024-05-30 12:02:11 +07:00
frontend Make this project public, add link & license info 2024-06-10 22:40:44 +07:00
handler Lowercase & upperase initialism acronyms 2024-06-10 03:03:23 +07:00
internal Uppercase CheckAPI test func 2024-06-10 03:23:03 +07:00
.air.toml Build server tags in Makefile & air config #3 2024-05-18 18:05:53 +07:00
.editorconfig Copying my other project structure to this project 2024-05-04 00:11:56 +07:00
.env.example Secret key environment variable no longer needed 2024-05-23 03:57:29 +07:00
.gitattributes Initial commit 2024-05-04 00:10:33 +07:00
.gitignore Adding GeoIP support 2024-05-05 02:20:54 +07:00
.golangci.yaml Adding test and bench example 2024-05-30 15:47:27 +07:00
go.mod Bump github.com/oschwald/geoip2-golang from 1.9.0 to 1.11.0 2024-06-03 05:18:45 +00:00
go.sum Bump github.com/oschwald/geoip2-golang from 1.9.0 to 1.11.0 2024-06-03 05:18:45 +00:00
LICENSE Initial commit 2024-05-04 00:10:33 +07:00
main.go Separating client and server package #3 2024-05-18 17:59:54 +07:00
Makefile chore: Rename tools directory to deployment 2024-05-30 12:02:11 +07:00
README.md Add build workflow 2024-06-10 23:44:01 +07:00
server.go Removing admin module and functions 2024-05-23 03:40:06 +07:00

README.md

XMR Remote Nodes

Lint BUild

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

⚠️ 🚧 This project is still freaking 0.x.x 🚧, 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

Installation

For initial server setup:

  1. Download GeoIP Database and place it to ./assets/geoip. (see ./internal/geo/ip.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: ./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 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

See the Makefile.

Similar Projects

License

This project is licensed under GLWTPL.