kvazar/keva-stratum
1
0
Fork 0
mirror of https://github.com/kvazar-network/keva-stratum.git synced 2025-01-29 16:24:13 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1 from mail2mz/master

Browse Source 
Updated instructions for Linux, Windows and MacOS.
This commit is contained in:
JustWonder 2019-11-24 18:00:39 -08:00 committed by GitHub
commit 3b34f50909
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -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:
@ -44,6 +44,16 @@ Build stratum:
cmake ..
make
Run stratum:
./keva-stratum config.json
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
### Mac OS X
Install Golang and required packages:
@ -62,9 +72,19 @@ Build stratum:
cmake ..
make
Run stratum:
./keva-stratum config.json
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
### 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.
@ -114,24 +134,18 @@ Now we are ready to build:
make
Run stratum:
### Running Stratum
keva-stratum.exe config.json
./keva-stratum config.json
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", //Please use 'kevacoin-cli getnewaddress' to get the address
// Don't validate address
"bypassAddressValidation": true,
// Don't validate shares
@ -182,8 +196,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", //The value should be the same as defined in kevacoin.config
"password": "yourpassword" //The value should be the same as defined in kevacoin.config
}
]
}
@ -191,7 +205,6 @@ 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.
### License
Released under the GNU General Public License v2.