Created API (markdown)

xmrig 2017-10-06 16:58:32 +03:00
parent 483aa678a8
commit 5ea5f71091

11
API.md Normal file

@ -0,0 +1,11 @@
In version **2.4.0** added HTTP API. If you build miner from source, **libmicrohttpd** dependency added. If you want use API you need choice a port where is internal HTTP server will listen for incoming connections.
Example configuration:
```json
"api": {
"port": 8080,
"access-token": "Optional Bearer Token used for authorization",
"worker-id": "Optional miner name"
}
```
If you prefer use command line options instead of config file, you can use options: `--api-port`, `--api-access-token` and `--api-worker-id`.