mirror of
https://github.com/xmrig/xmrig.git
synced 2024-11-18 10:01:06 +00:00
86 lines
4.8 KiB
Markdown
86 lines
4.8 KiB
Markdown
# XMRig
|
|
|
|
[](https://github.com/xmrig/xmrig/releases)
|
|
[](https://github.com/xmrig/xmrig/releases)
|
|
[](https://github.com/xmrig/xmrig/releases)
|
|
[](https://github.com/xmrig/xmrig/blob/master/LICENSE)
|
|
[](https://github.com/xmrig/xmrig/stargazers)
|
|
[](https://github.com/xmrig/xmrig/network)
|
|
|
|
XMRig is a high performance RandomX and CryptoNight CPU miner, with official support for Windows.
|
|
|
|
* This is the **CPU-mining** version, there is also a [NVIDIA GPU version](https://github.com/xmrig/xmrig-nvidia) and [AMD GPU version]( https://github.com/xmrig/xmrig-amd).
|
|
|
|
<img src="doc/screenshot.png" width="808" >
|
|
|
|
#### Table of contents
|
|
* [Download](#download)
|
|
* [Usage](#usage)
|
|
* [Build](https://github.com/xmrig/xmrig/wiki/Build)
|
|
* [Donations](#donations)
|
|
* [Contacts](#contacts)
|
|
|
|
## Download
|
|
* Binary releases: https://github.com/xmrig/xmrig/releases
|
|
* Git tree: https://github.com/xmrig/xmrig.git
|
|
* Clone with `git clone https://github.com/xmrig/xmrig.git` :hammer: [Build instructions](https://github.com/xmrig/xmrig/wiki/Build).
|
|
|
|
## Usage
|
|
Use [config.xmrig.com](https://config.xmrig.com/xmrig) to generate, edit or share configurations.
|
|
|
|
### Options
|
|
```
|
|
-a, --algo=ALGO specify the algorithm to use
|
|
cryptonight
|
|
cryptonight-lite
|
|
cryptonight-heavy
|
|
-o, --url=URL URL of mining server
|
|
-O, --userpass=U:P username:password pair for mining server
|
|
-u, --user=USERNAME username for mining server
|
|
-p, --pass=PASSWORD password for mining server
|
|
--rig-id=ID rig identifier for pool-side statistics (needs pool support)
|
|
-t, --threads=N number of miner threads
|
|
-v, --av=N algorithm variation, 0 auto select
|
|
-k, --keepalive send keepalived packet for prevent timeout (needs pool support)
|
|
--nicehash enable nicehash.com support
|
|
--tls enable SSL/TLS support (needs pool support)
|
|
--tls-fingerprint=F pool TLS certificate fingerprint, if set enable strict certificate pinning
|
|
-r, --retries=N number of times to retry before switch to backup server (default: 5)
|
|
-R, --retry-pause=N time to pause between retries (default: 5)
|
|
--cpu-affinity set process affinity to CPU core(s), mask 0x3 for cores 0 and 1
|
|
--cpu-priority set process priority (0 idle, 2 normal to 5 highest)
|
|
--no-huge-pages disable huge pages support
|
|
--no-color disable colored output
|
|
--variant algorithm PoW variant
|
|
--donate-level=N donate level, default 5% (5 minutes in 100 minutes)
|
|
--user-agent set custom user-agent string for pool
|
|
-B, --background run the miner in the background
|
|
-c, --config=FILE load a JSON-format configuration file
|
|
-l, --log-file=FILE log all output to a file
|
|
-S, --syslog use system log for output messages
|
|
--max-cpu-usage=N maximum CPU usage for automatic threads mode (default 75)
|
|
--safe safe adjust threads and av settings for current CPU
|
|
--asm=ASM ASM code for cn/2, possible values: auto, none, intel, ryzen.
|
|
--print-time=N print hashrate report every N seconds
|
|
--api-port=N port for the miner API
|
|
--api-access-token=T access token for API
|
|
--api-worker-id=ID custom worker-id for API
|
|
--api-id=ID custom instance ID for API
|
|
--api-ipv6 enable IPv6 support for API
|
|
--api-no-restricted enable full remote access (only if API token set)
|
|
--dry-run test configuration and exit
|
|
-h, --help display this help and exit
|
|
-V, --version output version information and exit
|
|
```
|
|
|
|
Also you can use configuration via config file, default name **config.json**. Some options available only via config file: [`autosave`](https://github.com/xmrig/xmrig/issues/767), [`hw-aes`](https://github.com/xmrig/xmrig/issues/563). `watch` option currently not implemented in miners only in proxy.
|
|
|
|
## Donations
|
|
* Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via option `donate-level` or disabled in source code.
|
|
* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`
|
|
* BTC: `1P7ujsXeX7GxQwHNnJsRMgAdNkFZmNVqJT`
|
|
|
|
## Contacts
|
|
* support@xmrig.com
|
|
* [reddit](https://www.reddit.com/user/XMRig/)
|
|
* [twitter](https://twitter.com/xmrig_dev)
|