xmrig/README.md

136 lines
6.6 KiB
Markdown
Raw Normal View History

2017-04-15 06:02:08 +00:00
# XMRig
2018-03-14 18:32:09 +00:00
2018-03-19 00:03:50 +00:00
:warning: **You must update miners to version 2.5 before April 6 due [Monero PoW change](https://getmonero.org/2018/02/11/PoW-change-and-key-reuse.html).**
2018-03-14 18:32:09 +00:00
2018-02-01 22:14:39 +00:00
[![Github All Releases](https://img.shields.io/github/downloads/xmrig/xmrig/total.svg)](https://github.com/xmrig/xmrig/releases)
2018-02-01 22:58:11 +00:00
[![GitHub release](https://img.shields.io/github/release/xmrig/xmrig/all.svg)](https://github.com/xmrig/xmrig/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date-pre/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/releases)
2018-02-01 22:14:39 +00:00
[![GitHub license](https://img.shields.io/github/license/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/blob/master/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/xmrig/xmrig.svg)](https://github.com/xmrig/xmrig/network)
2018-01-02 06:49:31 +00:00
XMRig is a high performance Monero (XMR) CPU miner, with official support for Windows.
Originally based on cpuminer-multi with heavy optimizations/rewrites and removing a lot of legacy code, since version 1.0.0 completely rewritten from scratch on C++.
2017-04-15 06:02:08 +00:00
2017-11-02 00:37:58 +00:00
* 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).
2017-10-12 19:40:20 +00:00
* [Roadmap](https://github.com/xmrig/xmrig/issues/106) for next releases.
2017-08-20 06:48:31 +00:00
2017-08-18 14:11:26 +00:00
<img src="http://i.imgur.com/OKZRVDh.png" width="619" >
2017-04-15 06:56:09 +00:00
2017-04-15 06:02:08 +00:00
#### Table of contents
* [Features](#features)
* [Download](#download)
* [Usage](#usage)
2017-04-21 09:34:59 +00:00
* [Algorithm variations](#algorithm-variations)
2017-06-14 13:49:47 +00:00
* [Build](https://github.com/xmrig/xmrig/wiki/Build)
2017-04-15 06:46:16 +00:00
* [Common Issues](#common-issues)
2017-04-15 06:02:08 +00:00
* [Other information](#other-information)
2017-05-13 17:31:27 +00:00
* [Donations](#donations)
2018-03-14 16:43:57 +00:00
* [Release checksums](#release-checksums)
2017-05-13 17:31:27 +00:00
* [Contacts](#contacts)
2017-04-15 06:02:08 +00:00
## Features
2017-08-20 07:32:52 +00:00
* High performance.
2017-04-15 06:02:08 +00:00
* Official Windows support.
2017-08-20 07:32:52 +00:00
* Small Windows executable, without dependencies.
* x86/x64 support.
2017-04-15 06:02:08 +00:00
* Support for backup (failover) mining server.
* keepalived support.
* Command line options compatible with cpuminer.
2017-05-13 17:26:35 +00:00
* CryptoNight-Lite support for AEON.
2017-05-15 16:57:20 +00:00
* Smart automatic [CPU configuration](https://github.com/xmrig/xmrig/wiki/Threads).
2017-05-20 20:43:39 +00:00
* Nicehash support
2017-04-15 06:02:08 +00:00
* It's open source software.
## Download
* Binary releases: https://github.com/xmrig/xmrig/releases
* Git tree: https://github.com/xmrig/xmrig.git
2017-08-18 03:47:51 +00:00
* Clone with `git clone https://github.com/xmrig/xmrig.git` :hammer: [Build instructions](https://github.com/xmrig/xmrig/wiki/Build).
2017-04-15 06:02:08 +00:00
## Usage
2018-02-18 21:17:50 +00:00
Use [config.xmrig.com](https://config.xmrig.com/xmrig) to generate, edit or share configurations.
2017-07-02 19:21:29 +00:00
2017-04-15 06:02:08 +00:00
### Options
```
2018-01-07 14:36:49 +00:00
-a, --algo=ALGO cryptonight (default) or cryptonight-lite
-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
-t, --threads=N number of miner threads
-v, --av=N algorithm variation, 0 auto select
-k, --keepalive send keepalived for prevent timeout (need pool support)
-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
2018-03-24 06:04:04 +00:00
--variant algorithm PoW variant
2018-01-07 14:36:49 +00:00
--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
2018-03-24 06:04:04 +00:00
-S, --syslog use system log for output messages
2018-01-07 14:36:49 +00:00
--max-cpu-usage=N maximum CPU usage for automatic threads mode (default 75)
--safe safe adjust threads and av settings for current CPU
--nicehash enable nicehash/xmrig-proxy support
--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
-h, --help display this help and exit
-V, --version output version information and exit
2017-04-15 06:02:08 +00:00
```
2017-08-18 03:47:51 +00:00
Also you can use configuration via config file, default **config.json**. You can load multiple config files and combine it with command line options.
2017-04-21 09:34:59 +00:00
## Algorithm variations
2017-05-13 17:26:35 +00:00
Since version 0.8.0.
* `--av=1` For CPUs with hardware AES.
* `--av=2` Lower power mode (double hash) of `1`.
* `--av=3` Software AES implementation.
* `--av=4` Lower power mode (double hash) of `3`.
2017-04-25 00:35:03 +00:00
2017-04-15 06:46:16 +00:00
## Common Issues
### HUGE PAGES unavailable
* Run XMRig as Administrator.
2018-01-02 06:49:31 +00:00
* Since version 0.8.0 XMRig automatically enables SeLockMemoryPrivilege for current user, but reboot or sign out still required. [Manual instruction](https://msdn.microsoft.com/en-gb/library/ms190730.aspx).
2017-04-15 06:46:16 +00:00
2017-04-15 06:02:08 +00:00
## Other information
* No HTTP support, only stratum protocol support.
* No TLS support.
* Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via command line option `--donate-level`.
### CPU mining performance
2017-08-20 06:55:03 +00:00
* **Intel i7-7700** - 307 H/s (4 threads)
* **AMD Ryzen 7 1700X** - 560 H/s (8 threads)
2017-04-15 06:02:08 +00:00
Please note performance is highly dependent on system load. The numbers above are obtained on an idle system. Tasks heavily using a processor cache, such as video playback, can greatly degrade hashrate. Optimal number of threads depends on the size of the L3 cache of a processor, 1 thread requires 2 MB of cache.
### Maximum performance checklist
* Idle operating system.
* Do not exceed optimal thread count.
2018-01-02 06:49:31 +00:00
* Use modern CPUs with AES-NI instruction set.
2017-04-15 06:02:08 +00:00
* Try setup optimal cpu affinity.
2017-04-15 06:46:16 +00:00
* Enable fast memory (Large/Huge pages).
## Donations
* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`
2017-04-15 06:56:09 +00:00
* BTC: `1P7ujsXeX7GxQwHNnJsRMgAdNkFZmNVqJT`
2017-04-21 09:34:59 +00:00
2018-03-14 16:43:57 +00:00
## Release checksums
### SHA-256
```
2018-03-26 06:59:20 +00:00
b070d06a3615f3db67ad3beab43d6d21f3c88026aa2b4726a93df47145cd30ec xmrig-2.5.2-xenial-amd64.tar.gz/xmrig-2.5.2/xmrig
4852135d3f04fd450ba39abce51ca40ff9131d222220c8b30804be05f6679295 xmrig-2.5.2-gcc-win32.zip/xmrig.exe
284309d07f08261af19c937ece6d2031910d9124a7359c207ded65890b2d7c5f xmrig-2.5.2-gcc-win64.zip/xmrig.exe
e1dc46158a578fb030538fb06e5663a6acc5763545fb447a00ce0a6b388c5226 xmrig-2.5.2-msvc-win64.zip/xmrig.exe
2018-03-14 16:43:57 +00:00
```
2017-04-21 09:34:59 +00:00
## Contacts
* support@xmrig.com
* [reddit](https://www.reddit.com/user/XMRig/)