mirror of
https://github.com/ditatompel/xmr-remote-nodes.git
synced 2024-10-30 00:47:46 +00:00
c3f837e122
This commit add IsIPv6Only function inside `internal/ip` package and moving `geo` package from `internal/geo` to `internal/ip/geo`. Although it increases server resource usage, checking hostname to IP is required every time the prober sends a report so that the `ipv6_only` record in the database is not up-to-date. Previously, this feature did not exist.
92 lines
3.8 KiB
Markdown
92 lines
3.8 KiB
Markdown
# XMR Remote Nodes
|
|
|
|
[](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/test.yml)
|
|
[](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/build.yml)
|
|
[](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/release.yml)
|
|
[](https://goreportcard.com/report/github.com/ditatompel/xmr-remote-nodes)
|
|
|
|
Source code of [https://xmr.ditatompel.com](https://xmr.ditatompel.com),
|
|
a website that helps you monitor your favourite Monero remote nodes.
|
|
|
|
> :warning: :construction: This project is not mature enough :construction:,
|
|
> 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][geoip_doc] (optional). Place it to `./assets/geoip`,
|
|
see [./internal/ip/geo/geoip.go](./internal/ip/geo/geoip.go).
|
|
|
|
## Installation
|
|
|
|
### For initial server setup:
|
|
|
|
1. Download [GeoIP Database][geoip_doc] and place it to `./assets/geoip`.
|
|
(see [./internal/ip/geo/geoip.go](./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][server_systemd_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][prober_systemd_service] and
|
|
[xmr-nodes-prober.timer][prober_systemd_timer].
|
|
|
|
## Development and Deployment
|
|
|
|
See the [Makefile](./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
|
|
|
|
- [lalanza808/monero.fail][monerofail_gh]
|
|
- [cake-tech/upptime-monerocom][uptime_monerocom_gh]
|
|
|
|
## License
|
|
|
|
This project is licensed under [GLWTPL](./LICENSE).
|
|
|
|
[geoip_doc]: https://dev.maxmind.com/geoip/geoip2/geolite2/ "GeoIP documentation"
|
|
[server_systemd_service]: ./deployment/init/xmr-nodes-server.service "systemd service example for server"
|
|
[prober_systemd_service]: ./deployment/init/xmr-nodes-prober.service "systemd service example for prober"
|
|
[prober_systemd_timer]: ./deployment/init/xmr-nodes-prober.timer "systemd timer example for prober"
|
|
[monerofail_gh]: https://github.com/lalanza808/monero.fail "Lalanza808's monero.fail GitHub repository"
|
|
[uptime_monerocom_gh]: https://github.com/cake-tech/upptime-monerocom "monero.com uptime GitHub repository"
|