Ecosystem/xmr-remote-nodes
1
0
Fork 0
mirror of https://github.com/ditatompel/xmr-remote-nodes.git synced 2024-09-28 17:31:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: Added todo's to README and use link references

Browse source
This commit is contained in:
Christian Ditaputratama 2024-09-05 20:34:42 +07:00
parent bd7ddab4f3
commit 71b44eabac
No known key found for this signature in database
GPG key ID: 31D3D06D77950979
1 changed files with 36 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
README.md
View file

@ -5,18 +5,23 @@
[![Release Binaries](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/release.yml/badge.svg)](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/release.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/ditatompel/xmr-remote-nodes)](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.
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 still freaking 0.x.x :construction:,
> :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**.
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 **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.
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
@ -32,38 +37,56 @@ To build the executable binaries, you need:
### Server requirements
- MySQL/MariaDB
- [GeoIP Database](https://dev.maxmind.com/geoip/geoip2/geolite2/) (optional). Place it to `./assets/geoip`, see [./internal/geo/ip.go](./internal/geo/ip.go).
- [GeoIP Database][geoip_doc] (optional). Place it to `./assets/geoip`,
see [./internal/geo/ip.go](./internal/geo/ip.go).
## Installation
### For initial server setup:
1. Download [GeoIP Database](https://dev.maxmind.com/geoip/geoip2/geolite2/) and place it to `./assets/geoip`. (see [./internal/geo/ip.go](./internal/geo/ip.go)).
1. Download [GeoIP Database][geoip_doc] and place it to `./assets/geoip`.
(see [./internal/geo/ip.go](./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).
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](./deployment/init/xmr-nodes-server.service).
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).
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](./deployment/init/xmr-nodes-prober.service) and [xmr-nodes-prober.timer](./deployment/init/xmr-nodes-prober.timer).
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](https://github.com/lalanza808/monero.fail)
- [cake-tech/upptime-monerocom](https://github.com/cake-tech/upptime-monerocom)
- [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"