From 9323e63405a5db03f5fd9bb3a07a713d222bff1d Mon Sep 17 00:00:00 2001 From: ditatompel Date: Mon, 3 Jun 2024 13:37:18 +0700 Subject: [PATCH] docs: Add build requirement information --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cfb36a0..69f777c 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,13 @@ The **server** serves an embedded Svelte static site for the Web UI. It also ser ## Requirements -### Server & Prober requirements +To build the executable binaries, you need: - Go >= 1.22 +- NodeJS >= 20 + +### Server & Prober requirements + - Linux Machines (AMD64 or ARM64) ### Server requirements @@ -27,9 +31,10 @@ The **server** serves an embedded Svelte static site for the Web UI. It also ser ### 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- serve`. +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- serve`. Systemd example: [./deployment/init/xmr-nodes-server.service](./deployment/init/xmr-nodes-server.service). @@ -37,7 +42,7 @@ Systemd example: [./deployment/init/xmr-nodes-server.service](./deployment/init/ 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`. +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- probe`. Systemd example: [xmr-nodes-prober.service](./deployment/init/xmr-nodes-prober.service) and [xmr-nodes-prober.timer](./deployment/init/xmr-nodes-prober.timer).