xmrig/README.md

162 lines
8.5 KiB
Markdown
Raw Normal View History

2017-04-15 06:02:08 +00:00
# XMRig
2018-03-14 18:32:09 +00:00
2018-10-19 03:19:18 +00:00
:warning: **[Monero changed PoW algorithm on October 18](https://github.com/xmrig/xmrig/issues/753), all miners and proxy should be updated to [v2.8+](https://github.com/xmrig/xmrig/releases/tag/v2.8.3)** :warning:
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-10-08 18:32:07 +00:00
-a, --algo=ALGO specify the algorithm to use
cryptonight
cryptonight-lite
cryptonight-heavy
2018-01-07 14:36:49 +00:00
-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
2018-10-08 18:32:07 +00:00
--rig-id=ID rig identifier for pool-side statistics (needs pool support)
2018-01-07 14:36:49 +00:00
-t, --threads=N number of miner threads
-v, --av=N algorithm variation, 0 auto select
2018-10-08 18:32:07 +00:00
-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
2018-01-07 14:36:49 +00:00
-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
2018-10-08 18:32:07 +00:00
--asm=ASM ASM code for cn/2, possible values: auto, none, intel, ryzen.
2018-01-07 14:36:49 +00:00
--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
2018-10-08 18:32:07 +00:00
--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
2018-01-07 14:36:49 +00:00
-h, --help display this help and exit
-V, --version output version information and exit
2017-04-15 06:02:08 +00:00
```
2018-10-08 18:32:07 +00:00
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.
2017-08-18 03:47:51 +00:00
2017-04-21 09:34:59 +00:00
## Algorithm variations
2018-09-28 09:36:14 +00:00
- `av` option used for automatic and simple threads mode (when you specify only threads count).
- For [advanced threads mode](https://github.com/xmrig/xmrig/issues/563) each thread configured individually and `av` option not used.
| av | Hashes per round | Hardware AES |
|----|------------------|--------------|
| 1 | 1 (Single) | yes |
| 2 | 2 (Double) | yes |
| 3 | 1 (Single) | no |
| 4 | 2 (Double) | no |
| 5 | 3 (Triple) | yes |
| 6 | 4 (Quard) | yes |
| 7 | 5 (Penta) | yes |
| 8 | 3 (Triple) | no |
| 9 | 4 (Quard) | no |
| 10 | 5 (Penta) | no |
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.
2018-09-28 09:37:21 +00:00
* Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via option `donate-level`.
2017-04-15 06:02:08 +00:00
### 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-10-19 03:19:18 +00:00
365198ed4f1205c42fa448d41c9088d3dea6bff43173c5e870e8bec4631c3a7d xmrig-2.8.3-xenial-amd64.tar.gz/xmrig-2.8.3/xmrig
77b235244eea7eab72c420c3575bc6c32eb83061d90b84addb187257c9819be7 xmrig-2.8.3-xenial-amd64.tar.gz/xmrig-2.8.3/xmrig-notls
586b81e455ed0aa7623507b0307ba34afdc2ff3494a822cbf1fcc0c1a86ac974 xmrig-2.8.3-gcc-win32.zip/xmrig.exe
2d35980542b603e02832c774ce0d0bc22e269f066bcdff20a919dcbd23e2ef2a xmrig-2.8.3-gcc-win32.zip/xmrig-notls.exe
0a638249271f3a7d7ad87643a1fa250cc21b9871dca951d15c7c214346cb02aa xmrig-2.8.3-gcc-win64.zip/xmrig.exe
0f9d05c96d2268f1cf3e2c120ad94e440a730e753efa2ae8cbc9ef4567b4da03 xmrig-2.8.3-gcc-win64.zip/xmrig-notls.exe
19600aead9ebc509db57538e5ace0a30604708c051b34f81c0bdc1b587624434 xmrig-2.8.3-msvc-win64.zip/xmrig.exe
b9380c58a863488c8d9d138bb32a92b5ab3bb7b4e614e8caa85239cbb2ca3c8b xmrig-2.8.3-msvc-win64.zip/xmrig-notls.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/)
2018-10-01 10:36:03 +00:00
* [twitter](https://twitter.com/xmrig_dev)