mirror of
https://github.com/xmrig/xmrig-proxy.git
synced 2026-02-08 18:49:16 +08:00
Update README.md
This commit is contained in:
27
README.md
27
README.md
@@ -6,27 +6,24 @@
|
||||
[](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.
|
||||
This is an extremely high-performance proxy for the CryptoNote stratum protocol (including Monero and others).
|
||||
It can efficiently manage over 100K connections on an inexpensive, low-memory virtual machine (with just 1024 MB of RAM).
|
||||
The proxy significantly reduces the number of connections to the pool, decreasing 100,000 workers down to just 391 on the pool side.
|
||||
The codebase is shared with the [XMRig](https://github.com/xmrig/xmrig) miner.
|
||||
|
||||
## Compatibility
|
||||
:warning: :warning: :warning: **Nicehash support must be enabled on miner side, it is 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.
|
||||
Compatible with any pool and any miner that supports NiceHash.
|
||||
|
||||
## Why?
|
||||
This proxy designed and created to handle donation traffic from XMRig. No one other solution works fine with high connection/disconnection rate.
|
||||
This proxy is designed to handle donation traffic from XMRig. No other solution works well with high connection and disconnection rates.
|
||||
|
||||
## 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).
|
||||
* Clone with `git clone https://github.com/xmrig/xmrig-proxy.git` :hammer: [Build instructions](https://xmrig.com/docs/proxy).
|
||||
|
||||
## Usage
|
||||
:boom: If you use Linux and want to 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.
|
||||
:boom: If you are using Linux and need to manage over **1000 connections**, you must [increase the limits on open files](https://github.com/xmrig/xmrig-proxy/wiki/Ubuntu-setup).
|
||||
|
||||
### Options
|
||||
```
|
||||
@@ -45,7 +42,9 @@ Network:
|
||||
--dns-ipv6 prefer IPv6 records from DNS responses
|
||||
--dns-ttl=N N seconds (default: 30) TTL for internal DNS cache
|
||||
--daemon use daemon RPC instead of pool for solo mining
|
||||
--daemon-zmq-port daemon's zmq-pub port number (only use it if daemon has it enabled)
|
||||
--daemon-poll-interval=N daemon poll interval in milliseconds (default: 1000)
|
||||
--daemon-job-timeout=N daemon job timeout in milliseconds (default: 15000)
|
||||
--self-select=URL self-select block templates from URL
|
||||
--submit-to-origin also submit solution back to self-select URL
|
||||
-r, --retries=N number of times to retry before switch to backup server (default: 5)
|
||||
@@ -82,7 +81,6 @@ TLS:
|
||||
--tls-ciphersuites=S set list of available TLSv1.3 ciphersuites
|
||||
|
||||
Logging:
|
||||
-S, --syslog use system log for output messages
|
||||
-l, --log-file=FILE log all output to a file
|
||||
-A --access-log-file=FILE log all workers access to a file
|
||||
--no-color disable colored output
|
||||
@@ -98,11 +96,10 @@ Misc:
|
||||
|
||||
## Donations
|
||||
|
||||
Default donation fee is 2%, but can be reduced to 1% or disabled via `donate-level` option. Donation fee applies only if you use more than 256 miners.
|
||||
The default donation fee is 2%, which can be reduced to 1% or completely disabled using the `donate-level` option. This fee applies only when you utilize more than 256 miners.
|
||||
|
||||
* XMR: `48edfHu7V9Z84YzzMa6fUueoELZ9ZRXq9VetWzYGzKt52XU5xvqgzYnDK9URnRoJMk1j8nLwEVsaSWJ4fhdUyZijBGUicoD`
|
||||
|
||||
## Contacts
|
||||
* support@xmrig.com
|
||||
* [reddit](https://www.reddit.com/user/XMRig/)
|
||||
* [twitter](https://twitter.com/xmrig_dev)
|
||||
* [X](https://x.com/xmrig_dev)
|
||||
|
||||
Reference in New Issue
Block a user