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

docs: Add build requirement information

Browse source
This commit is contained in:
ditatompel 2024-06-03 13:37:18 +07:00
parent 54d82e0c8f
commit 9323e63405
No known key found for this signature in database
GPG key ID: 31D3D06D77950979
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -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-<YOUR_CPU_ARCH> 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-<YOUR_CPU_ARCH> 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-<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).