xmr-remote-nodes/README.md

# 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.

## Requirements

### Server & Prober requirements

- Go >= 1.22
- Linux Machine (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. Copy `.env.example` to `.env` and edit it to match with server environment.
3. Build the binary with `make build`.
4. Run the service with `./bin/xmr-nodes-server-linux-<YOUR_CPU_ARCH> serve`.

To create admin user (for creating proberAPI key from Web-UI, execute `./bin/xmr-nodes-server-linux-<YOUR_CPU_ARCH> admin create`).

Systemd example: [./tools/resources/init/xmr-nodes-server.service](./tools/resources/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 build`.
4. Run the service with `./bin/xmr-nodes-client-linux-<YOUR_CPU_ARCH> probe`.

Systemd example: [xmr-nodes-prober.service](./tools/resources/init/xmr-nodes-prober.service) and [xmr-nodes-prober.timer](./tools/resources/init/xmr-nodes-prober.timer).
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`

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
			`## Requirements`

Adding repo description and update requirements 2024-05-17 10:40:22 +00:00			`### Server & Prober requirements`

Using slog for logging level The log level for the apps is using `log/slog` from Go standard library. This commit change log format for fiber http logger to match with the slog standard log format (date and time). This commit also remove `APP_DEBUG` field from config struct. TODO: Use `slog` for default app output. Note that in this commit, the `slog` output only implemented in `cron` "db migrate" and probe client. 2024-05-13 11:40:01 +00:00			`- Go >= 1.22`
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			`- Linux Machine (AMD64 or ARM64)`
Adding repo description and update requirements 2024-05-17 10:40:22 +00:00
			`### Server requirements`

			`- MySQL/MariaDB`
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			- [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)).
feat: MySQL db migration Create database schema migration for this app that run when the `serve` command is executed. 2024-05-11 21:19:40 +00:00			2. Copy `.env.example` to `.env` and edit it to match with server environment.
			3. Build the binary with `make build`.
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-server-linux-<YOUR_CPU_ARCH> serve`.
Adding systemd example for server service 2024-05-06 12:59:43 +00:00
Update the geoip package location 2024-05-22 17:39:31 +00:00			To create admin user (for creating proberAPI key from Web-UI, execute `./bin/xmr-nodes-server-linux-<YOUR_CPU_ARCH> admin create`).
Adding systemd service and timer for prober 2024-05-06 14:45:33 +00:00
Adding systemd example for server service 2024-05-06 12:59:43 +00:00			`Systemd example: [./tools/resources/init/xmr-nodes-server.service](./tools/resources/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.
			3. Build the binary with `make build`.
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
			`Systemd example: [xmr-nodes-prober.service](./tools/resources/init/xmr-nodes-prober.service) and [xmr-nodes-prober.timer](./tools/resources/init/xmr-nodes-prober.timer).`