xmr-remote-nodes/README.md

# XMR Remote Nodes

[![Test](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/test.yml/badge.svg)](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/test.yml)
[![BUild](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/build.yml/badge.svg)](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/build.yml)
[![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.

> :warning: :construction: This project is still freaking 0.x.x :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](https://dev.maxmind.com/geoip/geoip2/geolite2/) (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)).
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](./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](./deployment/init/xmr-nodes-prober.service) and [xmr-nodes-prober.timer](./deployment/init/xmr-nodes-prober.timer).

## Development and Deployment

See the [Makefile](./Makefile).

## Similar Projects

-   [lalanza808/monero.fail](https://github.com/lalanza808/monero.fail)
-   [cake-tech/upptime-monerocom](https://github.com/cake-tech/upptime-monerocom)

## License

This project is licensed under [GLWTPL](./LICENSE).
removing current page & next page in api response This response was used for my HTMX "infinite scroll" data, which is not used in this Svelte project. 2024-05-09 11:29:48 +00:00			`# XMR Remote Nodes`

chore(test): Add test shortcut to Makefile Also rename `.github/workflows/lint.yml` to `.github/workflows/test.yml` 2024-07-06 17:51:54 +00:00			`[![Test](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/test.yml/badge.svg)](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/test.yml)`
Add build workflow 2024-06-10 16:44:01 +00:00			`[![BUild](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/build.yml/badge.svg)](https://github.com/ditatompel/xmr-remote-nodes/actions/workflows/build.yml)`
chore: Add release binary action badge 2024-06-11 07:53:15 +00:00			`[![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)`
chore: Go Report Card badge added to README 2024-07-16 10:47:55 +00:00			`[![Go Report Card](https://goreportcard.com/badge/github.com/ditatompel/xmr-remote-nodes)](https://goreportcard.com/report/github.com/ditatompel/xmr-remote-nodes)`
Make this project public, add link & license info > When I wrote this, only God and I understood what I was doing. > Now, only God knows. Shout to https://github.com/me-shaon/GLWTPL 2024-06-10 15:40:44 +00:00
Adding repo description and update requirements 2024-05-17 10:40:22 +00:00			`Source code of [https://xmr.ditatompel.com](https://xmr.ditatompel.com), a website that helps you monitor your favourite Monero remote nodes.`
Adding GeoIP support 2024-05-04 19:20:54 +00:00
Make this project public, add link & license info > When I wrote this, only God and I understood what I was doing. > Now, only God knows. Shout to https://github.com/me-shaon/GLWTPL 2024-06-10 15:40:44 +00:00			`> :warning: :construction: This project is still freaking 0.x.x :construction:,`
			`> If you want to use it on your server, please use it with caution.`

Update readme on how the site works 2024-05-31 11:24:45 +00:00			`## 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.

Adding GeoIP support 2024-05-04 19:20:54 +00:00			`## Requirements`

docs: Add build requirement information 2024-06-03 06:37:18 +00:00			`To build the executable binaries, you need:`
Adding repo description and update requirements 2024-05-17 10:40:22 +00:00
chore: Fix formatting (prettier) 2024-05-28 03:03:29 +00:00			`- Go >= 1.22`
docs: Add build requirement information 2024-06-03 06:37:18 +00:00			`- NodeJS >= 20`

			`### Server & Prober requirements`

chore: Rename `tools` directory to `deployment` The `tools` directory contains example ansible playbook, systemd example, and Nginx configuration example for the server. The directory name `deployment` for that stuffs much more suitable. 2024-05-30 05:02:11 +00:00			`- Linux Machines (AMD64 or ARM64)`
Adding repo description and update requirements 2024-05-17 10:40:22 +00:00
			`### Server requirements`

chore: Fix formatting (prettier) 2024-05-28 03:03:29 +00:00			`- 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).
Adding GeoIP support 2024-05-04 19:20:54 +00:00
Adding systemd example for server service 2024-05-06 12:59:43 +00:00			`## Installation`
Adding GeoIP support 2024-05-04 19:20:54 +00:00
removing current page & next page in api response This response was used for my HTMX "infinite scroll" data, which is not used in this Svelte project. 2024-05-09 11:29:48 +00:00			`### For initial server setup:`
Adding systemd example for server service 2024-05-06 12:59:43 +00:00
Removing admin module and functions The administration of the server is done using cli tools. So I don't think that admin account and module is required. At least for now. Note that this also remove `tbl_admin` creation in database migrate. Since no release were made until this commit, the database migration still in version 1. Manual removal database table for `tbl_admin` is required on the existing running server. 2024-05-22 20:40:06 +00:00			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)).
docs: Add build requirement information 2024-06-03 06:37:18 +00:00			`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`.
Adding systemd example for server service 2024-05-06 12:59:43 +00:00
chore: Rename `tools` directory to `deployment` The `tools` directory contains example ansible playbook, systemd example, and Nginx configuration example for the server. The directory name `deployment` for that stuffs much more suitable. 2024-05-30 05:02:11 +00:00			`Systemd example: [./deployment/init/xmr-nodes-server.service](./deployment/init/xmr-nodes-server.service).`
Adding systemd service and timer for prober 2024-05-06 14:45:33 +00:00
removing current page & next page in api response This response was used for my HTMX "infinite scroll" data, which is not used in this Svelte project. 2024-05-09 11:29:48 +00:00			`### For initial prober setup:`
Adding systemd service and timer for prober 2024-05-06 14:45:33 +00:00
			`1. Create API key for prober`
			2. Copy `.env.example` to `.env` and edit it to match with prober environment.
docs: Add build requirement information 2024-06-03 06:37:18 +00:00			3. Build the binary with `make client` (or `make build` to build both server and client binaries).
Build server tags in Makefile & `air` config #3 The build system is changed, now it build 2 different binary by using go `-tags`. The local output binary also changed based on build tags. 2024-05-18 11:05:53 +00:00			4. Run the service with `./bin/xmr-nodes-client-linux-<YOUR_CPU_ARCH> probe`.
Adding systemd service and timer for prober 2024-05-06 14:45:33 +00:00
chore: Rename `tools` directory to `deployment` The `tools` directory contains example ansible playbook, systemd example, and Nginx configuration example for the server. The directory name `deployment` for that stuffs much more suitable. 2024-05-30 05:02:11 +00:00			`Systemd example: [xmr-nodes-prober.service](./deployment/init/xmr-nodes-prober.service) and [xmr-nodes-prober.timer](./deployment/init/xmr-nodes-prober.timer).`
Update readme on how the site works 2024-05-31 11:24:45 +00:00
			`## Development and Deployment`

			`See the [Makefile](./Makefile).`
chore: Add similar projects to the README.md 2024-06-10 14:32:01 +00:00
			`## Similar Projects`

			`- [lalanza808/monero.fail](https://github.com/lalanza808/monero.fail)`
			`- [cake-tech/upptime-monerocom](https://github.com/cake-tech/upptime-monerocom)`
Make this project public, add link & license info > When I wrote this, only God and I understood what I was doing. > Now, only God knows. Shout to https://github.com/me-shaon/GLWTPL 2024-06-10 15:40:44 +00:00
			`## License`

			`This project is licensed under [GLWTPL](./LICENSE).`