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

Update readme on how the site works

Browse source
This commit is contained in:
ditatompel 2024-05-31 18:24:45 +07:00
parent e983db2b29
commit c6d48764a2
No known key found for this signature in database
GPG key ID: 31D3D06D77950979
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -2,6 +2,14 @@
Source code of [https://xmr.ditatompel.com](https://xmr.ditatompel.com), a website that helps you monitor your favourite Monero remote nodes.
## 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
### Server & Prober requirements
@ -33,3 +41,7 @@ Systemd example: [./deployment/init/xmr-nodes-server.service](./deployment/init/
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).
## Development and Deployment
See the [Makefile](./Makefile).