mirror of
https://github.com/kvazar-network/keva-stratum.git
synced 2025-03-12 14:01:16 +00:00
Update README.md
This commit is contained in:
parent
748987c32b
commit
bd7d32770b
16
README.md
16
README.md
@ -25,7 +25,7 @@ Dependencies:
|
||||
|
||||
### Linux
|
||||
|
||||
Use Ubuntu 16.04 LTS or 18.04 LTS.
|
||||
Use Ubuntu 16.04 LTS or 18.04 LTS, or Ubuntu on Windows Linux Subsystem(WLS).
|
||||
|
||||
Install Golang and required packages:
|
||||
|
||||
@ -65,6 +65,8 @@ Build stratum:
|
||||
|
||||
### Windows
|
||||
|
||||
If you are using Windows Linux Sytem (WLS), please check the instruction under ### Lunix.
|
||||
|
||||
Just like Monero, keva-stratum can be built on Windows using the MinGW toolchain within [MSYS2](https://www.msys2.org/) environment.
|
||||
|
||||
- Download and install the [MSYS2 installer](https://www.msys2.org/), either the 64-bit or the 32-bit package, depending on your system.
|
||||
@ -116,7 +118,8 @@ Now we are ready to build:
|
||||
|
||||
|
||||
### Running Stratum
|
||||
|
||||
Is the command exactly the same for linux and windows?
|
||||
|
||||
./keva-stratum config.json
|
||||
|
||||
If you need to bind to privileged ports and don't want to run from `root`:
|
||||
@ -124,14 +127,14 @@ If you need to bind to privileged ports and don't want to run from `root`:
|
||||
sudo apt-get install libcap2-bin
|
||||
sudo setcap 'cap_net_bind_service=+ep' /path/to/keva-stratum
|
||||
|
||||
## Configuration
|
||||
## Configuration (config.json)
|
||||
|
||||
Configuration is self-describing, just copy *config.example.json* to *config.json* and run stratum with path to config file as 1st argument.
|
||||
|
||||
```javascript
|
||||
{
|
||||
// Address for block rewards
|
||||
"address": "YOUR-ADDRESS-NOT-EXCHANGE",
|
||||
"address": "YOUR-ADDRESS-NOT-EXCHANGE", --how do user get the address by themselves?
|
||||
// Don't validate address
|
||||
"bypassAddressValidation": true,
|
||||
// Don't validate shares
|
||||
@ -182,8 +185,8 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso
|
||||
"host": "127.0.0.1",
|
||||
"port": 18081,
|
||||
"timeout": "10s",
|
||||
"user": "yourusername",
|
||||
"password": "yourpassword"
|
||||
"user": "yourusername", #should be the same as kevacoin.config
|
||||
"password": "yourpassword" #should be the same as kevacoin.config
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -191,6 +194,7 @@ Configuration is self-describing, just copy *config.example.json* to *config.jso
|
||||
|
||||
The `upstream` is used to point to the Kevacoin daemon `kevacoind`. The `user` and `password` under `upstream` are mandatory, and they must be the same as the ones specified in Kevacoin configuration file `kevacoin.conf`. You must use `anything.WorkerID` as username in your miner. Either disable address validation or use `<address>.WorkerID` as username. If there is no workerID specified your rig stats will be merged under `0` worker. If mining software contains dev fee rounds its stats will usually appear under `0` worker. This stratum acts like your own pool, the only exception is that you will get rewarded only after block found, shares only used for stats.
|
||||
|
||||
Should we add the URL for https://github.com/xmrig/xmrig/wiki/Ubuntu-Build
|
||||
|
||||
### License
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user