mirror of
https://github.com/xmrig/xmrig-proxy.git
synced 2026-02-09 02:59:17 +08:00
84 lines
5.2 KiB
Markdown
84 lines
5.2 KiB
Markdown
# XMRig Proxy
|
|
[](https://github.com/xmrig/xmrig-proxy/releases)
|
|
[](https://github.com/xmrig/xmrig-proxy/releases)
|
|
[](https://github.com/xmrig/xmrig-proxy/releases)
|
|
[](https://github.com/xmrig/xmrig-proxy/blob/master/LICENSE)
|
|
[](https://github.com/xmrig/xmrig-proxy/stargazers)
|
|
[](https://github.com/xmrig/xmrig-proxy/network)
|
|
|
|
Extremely high performance Monero (XMR) Stratum protocol proxy, can easily handle over 100K connections on cheap $5 (1024 MB) virtual machine. Reduce number of pool connections up to 256 times, 100K workers become just 391 worker on pool side. Written on C++/libuv same as [XMRig](https://github.com/xmrig/xmrig) miner.
|
|
|
|
## Compatibility
|
|
:warning: :warning: :warning: **Nicehash support must be enabled on miner side, it mandatory.** :warning: :warning: :warning:
|
|
|
|
* Compatible with any Monero, Electroneum, Sumokoin and AEON pools, except **nicehash.com**.
|
|
* Any miner with nicehash support, `--nicehash` option for [XMRig](https://github.com/xmrig/xmrig), `"nicehash_nonce": true,` for xmr-stak-cpu.
|
|
* [Comparison](https://github.com/xmrig/xmrig-proxy/wiki/Comparison) with other proxies.
|
|
|
|
## Why?
|
|
This proxy designed and created for handle donation traffic from XMRig. No one other solution works fine with high connection/disconnection rate.
|
|
|
|
## Download
|
|
* Binary releases: https://github.com/xmrig/xmrig-proxy/releases
|
|
* Git tree: https://github.com/xmrig/xmrig-proxy.git
|
|
* Clone with `git clone https://github.com/xmrig/xmrig-proxy.git` :hammer: [Build instructions](https://github.com/xmrig/xmrig-proxy/wiki/Build).
|
|
|
|
## Usage
|
|
:boom: If you use Linux and want handle more than **1000 connections**, you need [increase limits of open files](https://github.com/xmrig/xmrig-proxy/wiki/Ubuntu-setup).
|
|
|
|
Use [config.xmrig.com](https://config.xmrig.com/proxy) to generate, edit or share configurations.
|
|
|
|
### Options
|
|
```
|
|
-b, --bind=ADDR bind to specified address, example "0.0.0.0:3333"
|
|
-a, --algo=ALGO cryptonight (default) or cryptonight-lite
|
|
-m, --mode=MODE proxy mode, nicehash (default) or simple
|
|
-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
|
|
-r, --retries=N number of times to retry before switch to backup server (default: 1)
|
|
-R, --retry-pause=N time to pause between retries (default: 1 second)
|
|
--custom-diff=N override pool diff
|
|
--reuse-timeout=N timeout in seconds for reuse pool connections in simple mode
|
|
--verbose verbose output
|
|
--user-agent=AGENT set custom user-agent string for pool
|
|
--no-color disable colored output
|
|
--no-workers disable per worker statistics
|
|
--variant algorithm PoW variant
|
|
--donate-level=N donate level, default 2%
|
|
-B, --background run the miner in the background
|
|
-c, --config=FILE load a JSON-format configuration file
|
|
--no-watch disable configuration file watching
|
|
-l, --log-file=FILE log all output to a file
|
|
-S, --syslog use system log for output messages
|
|
-A --access-log-file=N log all workers access to a file
|
|
--api-port=N port for the miner API
|
|
--api-access-token=T use Bearer access token for API
|
|
--api-worker-id=ID custom worker-id for API
|
|
--api-no-ipv6 disable IPv6 support for API
|
|
--api-no-restricted enable full remote access (only if API token set)
|
|
--tls enable SSL/TLS support for pool connection (needs pool support)
|
|
--tls-bind=ADDR bind to specified address with enabled TLS
|
|
--tls-cert=FILE load TLS certificate chain from a file in the PEM format
|
|
--tls-cert-key=FILE load TLS certificate private key from a file in the PEM format
|
|
--tls-dhparam=FILE load DH parameters for DHE ciphers from a file in the PEM format
|
|
--tls-protocols=N enable specified TLS protocols, example: "TLSv1 TLSv1.1 TLSv1.2 TLSv1.3"
|
|
--tls-ciphers=S set list of available ciphers (TLSv1.2 and below)
|
|
--tls-ciphersuites=S set list of available TLSv1.3 ciphersuites
|
|
-h, --help display this help and exit
|
|
-V, --version output version information and exit
|
|
```
|
|
|
|
## Donations
|
|
|
|
Default donation fee is 2% can be reduced to 1% or disabled via `donate-level` option. Donation fee applies only if you use more than 256 miners.
|
|
|
|
* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`
|
|
* BTC: `1P7ujsXeX7GxQwHNnJsRMgAdNkFZmNVqJT`
|
|
|
|
## Contacts
|
|
* support@xmrig.com
|
|
* [reddit](https://www.reddit.com/user/XMRig/)
|
|
* [twitter](https://twitter.com/xmrig_dev)
|