Ecosystem/xmrig
Ecosystem/xmrig
1
0
Fork 0
mirror of https://github.com/xmrig/xmrig.git synced 2024-12-25 04:59:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'evo' of github.com:xmrig/xmrig into evo

Browse source
This commit is contained in:
XMRig 2019-08-10 17:50:48 +07:00
commit 732a2f7bb9
1 changed files with 47 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

91
README.md
View file

@ -26,55 +26,58 @@ XMRig is a high performance RandomX and CryptoNight CPU miner, with official sup
* Clone with `git clone https://github.com/xmrig/xmrig.git` :hammer: [Build instructions](https://github.com/xmrig/xmrig/wiki/Build). * Clone with `git clone https://github.com/xmrig/xmrig.git` :hammer: [Build instructions](https://github.com/xmrig/xmrig/wiki/Build).
## Usage ## Usage
Use [config.xmrig.com](https://config.xmrig.com/xmrig) to generate, edit or share configurations. Preferend way to configure miner is [JSON config file](src/config.json) as more flexible and human frendly, command line interface not cover all features, for example mining profiles for different algorithms. Most impotant options can be changed in runtime without miner restart by editing config or via API.
### Options ### Options
``` ```
-a, --algo=ALGO specify the algorithm to use -a, --algo=ALGO specify the algorithm to use
cryptonight cn/r, cn/2, cn/1, cn/0, cn/double, cn/half, cn/fast,
cryptonight-lite cn/rwz, cn/zls, cn/xao, cn/rto, cn/gpu,
cryptonight-heavy cn-lite/1,
-o, --url=URL URL of mining server cn-heavy/xhv, cn-heavy/tube, cn-heavy/0,
-O, --userpass=U:P username:password pair for mining server cn-pico,
-u, --user=USERNAME username for mining server rx/wow, rx/loki
-p, --pass=PASSWORD password for mining server -o, --url=URL URL of mining server
--rig-id=ID rig identifier for pool-side statistics (needs pool support) -O, --userpass=U:P username:password pair for mining server
-t, --threads=N number of miner threads -u, --user=USERNAME username for mining server
-v, --av=N algorithm variation, 0 auto select -p, --pass=PASSWORD password for mining server
-k, --keepalive send keepalived packet for prevent timeout (needs pool support) --rig-id=ID rig identifier for pool-side statistics (needs pool support)
--nicehash enable nicehash.com support -t, --threads=N number of miner threads
--tls enable SSL/TLS support (needs pool support) -v, --av=N algorithm variation, 0 auto select
--tls-fingerprint=F pool TLS certificate fingerprint, if set enable strict certificate pinning -k, --keepalive send keepalived packet for prevent timeout (needs pool support)
-r, --retries=N number of times to retry before switch to backup server (default: 5) --nicehash enable nicehash.com support
-R, --retry-pause=N time to pause between retries (default: 5) --tls enable SSL/TLS support (needs pool support)
--cpu-affinity set process affinity to CPU core(s), mask 0x3 for cores 0 and 1 --tls-fingerprint=F pool TLS certificate fingerprint, if set enable strict certificate pinning
--cpu-priority set process priority (0 idle, 2 normal to 5 highest) --daemon use daemon RPC instead of pool for solo mining
--no-huge-pages disable huge pages support --daemon-poll-interval=N daemon poll interval in milliseconds (default: 1000)
--no-color disable colored output -r, --retries=N number of times to retry before switch to backup server (default: 5)
--variant algorithm PoW variant -R, --retry-pause=N time to pause between retries (default: 5)
--donate-level=N donate level, default 5% (5 minutes in 100 minutes) --cpu-affinity set process affinity to CPU core(s), mask 0x3 for cores 0 and 1
--user-agent set custom user-agent string for pool --cpu-priority set process priority (0 idle, 2 normal to 5 highest)
-B, --background run the miner in the background --no-huge-pages disable huge pages support
-c, --config=FILE load a JSON-format configuration file --no-color disable colored output
-l, --log-file=FILE log all output to a file --donate-level=N donate level, default 5% (5 minutes in 100 minutes)
-S, --syslog use system log for output messages --user-agent set custom user-agent string for pool
--max-cpu-usage=N maximum CPU usage for automatic threads mode (default 75) -B, --background run the miner in the background
--safe safe adjust threads and av settings for current CPU -c, --config=FILE load a JSON-format configuration file
--asm=ASM ASM code for cn/2, possible values: auto, none, intel, ryzen. -l, --log-file=FILE log all output to a file
--print-time=N print hashrate report every N seconds --asm=ASM ASM optimizations, possible values: auto, none, intel, ryzen, bulldozer.
--api-port=N port for the miner API --print-time=N print hashrate report every N seconds
--api-access-token=T access token for API --api-worker-id=ID custom worker-id for API
--api-worker-id=ID custom worker-id for API --api-id=ID custom instance ID for API
--api-id=ID custom instance ID for API --http-enabled enable HTTP API
--api-ipv6 enable IPv6 support for API --http-host=HOST bind host for HTTP API (default: 127.0.0.1)
--api-no-restricted enable full remote access (only if API token set) --http-port=N bind port for HTTP API
--dry-run test configuration and exit --http-access-token=T access token for HTTP API
-h, --help display this help and exit --http-no-restricted enable full remote access to HTTP API (only if access token set)
-V, --version output version information and exit --randomx-init=N threads count to initialize RandomX dataset
--randomx-no-numa disable NUMA support for RandomX
--export-topology export hwloc topology to a XML file and exit
--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 ## Donations
* Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via option `donate-level` or disabled in source code. * Default donation 5% (5 minutes in 100 minutes) can be reduced to 1% via option `donate-level` or disabled in source code.
* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD` * XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`