Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Bendr0id/xmrigCC
RandomX, CryptoNight, Argon2 and GhostRider CPU/GPU miner with Command&Control (CC) Server and Monitoring
https://github.com/Bendr0id/xmrigCC
admin argon2 armv8 cc cryptonight dashboard ghostrider linux monitoring randomx remote-control windows
Last synced: 12 days ago
JSON representation
RandomX, CryptoNight, Argon2 and GhostRider CPU/GPU miner with Command&Control (CC) Server and Monitoring
- Host: GitHub
- URL: https://github.com/Bendr0id/xmrigCC
- Owner: Bendr0id
- License: gpl-3.0
- Fork: true (xmrig/xmrig)
- Created: 2017-10-03T09:23:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T18:08:56.000Z (6 months ago)
- Last Synced: 2024-08-01T19:31:25.896Z (3 months ago)
- Topics: admin, argon2, armv8, cc, cryptonight, dashboard, ghostrider, linux, monitoring, randomx, remote-control, windows
- Language: C
- Homepage:
- Size: 45 MB
- Stars: 311
- Watchers: 38
- Forks: 107
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# XMRigCC
XMRigCC is a high performance, open source, cross platform RandomX, GhostRider, KawPow, CryptoNight
unified CPU/GPU miner. Official binaries are available for Windows, Linux, freebsd, macOS and Android.
[](https://ci.appveyor.com/project/Bendr0id/xmrigcc)
[](https://hub.docker.com/r/bendr0id/xmrigcc/)
[](https://github.com/bendr0id/xmrigCC/releases)
[](https://github.com/bendr0id/xmrigCC/releases)
[](https://github.com/bendr0id/xmrigCC/releases)
[](https://github.com/bendr0id/xmrigCC/stargazers)
[](https://discord.gg/r3rCKTB)
### About [CC]
XMRigCC is a [XMRig](https://github.com/xmrig/xmrig) fork which adds remote control and monitoring functions to XMRigCC miners. It lets you control your miners via a Dashboard or the REST api.
XMRigCC has a "Command and Control" (CC) server part, a daemon to keep the XMRigCC miner alive and modifications to send the current status to the CC Server.
The modified version can handle commands like "update config", "start/stop mining" or "restart/shutdown/reboot" which can be send from the CC-Server Dashboard.
Assign config templates to multiple miners with a single click and let them switch configs without connecting to each of them.
Watch your miners logs with the simple remote Log viewer and monitor you miners. When the hashrate drops or one of your miners went offline you can get a notification via
PushOver or Telegram automatically so that you dont need to watch your miners all day.
Full Windows/Linux/OSx/Android compatible, and you can mix all on a single XMRigCC-Server.
## Latest integrated algos in XMRigCC:
List of all supported algos can be found [here](doc/ALGORITHMS.md)
* **Equilibria (XEQ)** RX variant (Algo: "rx/xeq")
* **Tuske** RX variant (Algo: "rx/tuske")
* **VKAX** Ghostrider variant Mike (Algo: "mike")
* **XDagger** RX variant (Algo: "rx/xdag")
* **Conceal (CCX), RYO, ...** CN variant (Algo: "cn/gpu")
* **Ghostrider (Raptoreum)** (Algo: "gr")
* **KawPow (Ravencoin)** (Algo: "kawpow")
* **Graft** RX variant (Algo: "rx/graft")
* **Yadacoin** RX variant (Algo: "rx/yada")
## XMRigCC features:
* Better performance on ARMv8 CPUs
* Full SSL/TLS support
* NUMA support
* Command and control server
* CC Dashboard with:
* statistics of all connected miners with graphs (CPU+GPU)
* remote control miners (start/stop/restart/shutdown/execute)
* remote configure miners
* remote miner upgrade **[Howto](doc/REMOTE_MINER_UPDATE.md)**
* simple config editor for miner / config templates / apply to all
* monitoring
* remote logging
* configurable alarm notifications via Pushover and Telegram
* Daemon to restart the miner
## Mining backends
- **CPU** (x86/x64/ARMv7/ARMv8)
- **OpenCL** for AMD GPUs.
- **CUDA** for NVIDIA GPUs use:
- XMRig's official [CUDA plugin](https://github.com/xmrig/xmrig-cuda/releases)
- MoneroOcean's [CUDA plugin](https://github.com/MoneroOcean/xmrig-cuda/releases) **with CN/GPU** support
**XMRigCC Server/Dashboard**
**XMRigCC Miner**
#### Table of contents
* [Download](#download)
* [Usage](#usage)
* [Wiki/Building/Howto](https://github.com/Bendr0id/xmrigCC/wiki/)
* [Common Issues](#common-issues)
* [Donations](#donations)
* [Contacts](#contact)
## Download
* Binary releases: https://github.com/Bendr0id/xmrigCC/releases
* Git tree: https://github.com/Bendr0id/xmrigCC.git
* Clone with `git clone https://github.com/Bendr0id/xmrigCC.git` :hammer: [official XMRig Build instructions](https://xmrig.com/docs/miner/build)
## Usage
### Basic example XMRigCCServer
```
xmrigServer --port=3344 --user=admin --pass=pass --token=SECRET_TOKEN_TO_ACCESS_CC_SERVER
```
### Options XMRigCCServer
```
-b, --bind arg The CC Server bind ip (default: 0.0.0.0)
-p, --port N The CC Server port
-U, --user arg The CC Server admin user
-P, --pass arg The CC Server admin pass
-T, --token arg The CC Server access token for the CC Client
-t, --tls Enable SSL/TLS support
-K, --key-file FILE The private key file to use when TLS is ON
(default: server.key)
-C, --cert-file FILE The cert file to use when TLS is ON (default:
server.pem)
-B, --background Run the Server in the background
-S, --syslog Log to the syslog
--no-colors Disable colored output
--pushover-user-key arg The user key for pushover notifications
--pushover-api-token arg The api token/keytoken of the application for
pushover notification
--telegram-bot-token arg The bot token for telegram notifications
--telegram-chat-id arg The chat-id for telegram notifications
--push-miner-offline-info
Push notification for offline miners and
recovery (default: true)
--push-miner-zero-hash-info
Push notification when miner reports 0
hashrate and recovers (default: true)
--push-periodic-mining-status
Push every hour a status notification
(default: true)
--custom-dashboard FILE The custom dashboard to use (default:
index.html)
--client-config-folder FOLDER
The CC Server access token for the CC Client
--log-file FILE The log file to write
--client-log-lines-history N
Maximum lines of log history kept per miner
(default: 1000)
-c, --config FILE The JSON-format configuration file to use
-h, --help Print this help
```
### Basic example xmrigDaemon
```
xmrigDaemon -o pool.hashvault.pro:5555 -u YOUR_WALLET -p x -k --cc-url=IP_OF_CC_SERVER:PORT --cc-access-token=SECRET_TOKEN_TO_ACCESS_CC_SERVER --cc-worker-id=OPTIONAL_WORKER_NAME
```
### Options xmrigDaemon
```
Network:
-o, --url=URL URL of mining server
-a, --algo=ALGO mining algorithm (https://github.com/Bendr0id/xmrigCC/blob/master/doc/ALGORITHMS.md)
--coin=COIN specify coin instead of algorithm
-u, --user=USERNAME username for mining server
-p, --pass=PASSWORD password for mining server
-O, --userpass=U:P username:password pair for mining server
-x, --proxy=HOST:PORT connect through a SOCKS5 proxy
-k, --keepalive send keepalived packet for prevent timeout (needs pool support)
--nicehash enable nicehash.com support
--rig-id=ID rig identifier for pool-side statistics (needs pool support)
--tls enable SSL/TLS support (needs pool support)
--tls-fingerprint=HEX pool TLS certificate fingerprint for strict certificate pinning
--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-poll-interval=N daemon poll interval in milliseconds (default: 1000)
--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)
-R, --retry-pause=N time to pause between retries (default: 5)
--user-agent set custom user-agent string for pool
--donate-level=N donate level, can be reduced to 1% [1 minute in 100] (minimum) (default: 3%)
CPU backend:
--no-cpu disable CPU mining backend
-t, --threads=N number of CPU threads, proper CPU affinity required for some optimizations.
--cpu-affinity=N set process affinity to CPU core(s), mask 0x3 for cores 0 and 1
-v, --av=N algorithm variation, 0 auto select
--cpu-priority=N set process priority (0 idle, 2 normal to 5 highest)
--cpu-max-cpu-usage=N set maximum CPU usage (in percentage) on all used threads
--cpu-max-threads-hint=N maximum CPU threads count (in percentage) hint for autoconfig
--cpu-memory-pool=N number of 2 MB pages for persistent memory pool, -1 (auto), 0 (disable)
--cpu-no-yield prefer maximum hashrate rather than system response/stability
--cpu-force-autoconfig force cpu autoconfig, but keeps disabled algos
--no-huge-pages disable huge pages support
--hugepage-size=N custom hugepage size in kB
--huge-pages-jit enable huge pages support for RandomX JIT code
--asm=ASM ASM optimizations, possible values: auto, none, intel, ryzen, bulldozer
--argon2-impl=IMPL argon2 implementation: x86_64, SSE2, SSSE3, XOP, AVX2, AVX-512F
--randomx-init=N threads count to initialize RandomX dataset
--randomx-no-numa disable NUMA support for RandomX
--randomx-mode=MODE RandomX mode: auto, fast, light
--randomx-1gb-pages use 1GB hugepages for RandomX dataset (Linux only)
--randomx-wrmsr=N write custom value(s) to MSR registers or disable MSR mod (-1)
--randomx-no-rdmsr disable reverting initial MSR values on exit
--randomx-cache-qos enable Cache QoS
OpenCL backend:
--opencl enable OpenCL mining backend
--opencl-devices=N comma separated list of OpenCL devices to use
--opencl-platform=N OpenCL platform index or name
--opencl-loader=PATH path to OpenCL-ICD-Loader (OpenCL.dll or libOpenCL.so)
--opencl-no-cache disable OpenCL cache
--print-platforms print available OpenCL platforms and exit
CUDA backend:
--cuda enable CUDA mining backend
--cuda-loader=PATH path to CUDA plugin (xmrig-cuda.dll or libxmrig-cuda.so)
--cuda-devices=N comma separated list of CUDA devices to use
--cuda-bfactor-hint=N bfactor hint for autoconfig (0-12)
--cuda-bsleep-hint=N bsleep hint for autoconfig
--no-nvml disable NVML (NVIDIA Management Library) support
API:
--api-worker-id=ID custom worker-id for API
--api-id=ID custom instance ID for API
--http-host=HOST bind host for HTTP API (default: 127.0.0.1)
--http-port=N bind port for HTTP API
--http-access-token=T access token for HTTP API
--http-no-restricted enable full remote access to HTTP API (only if access token set)
TLS:
--tls-gen=HOSTNAME generate TLS certificate for specific hostname
--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
CC feature:
--cc-disabled disable CC Client feature
--cc-url=URL url of the CC Server
--cc-access-token=T access token for CC Server
--cc-worker-id=ID custom worker-id for CC Server
--cc-update-interval-s=N status update interval in seconds (default: 10 min: 1)
--cc-retries-to-failover=N retries before we failover to alternate CC Server (default: 5 min: 1)
--cc-use-tls enable tls encryption for CC communication
--cc-use-remote-logging enable remote logging on CC Server
--cc-upload-config-on-start upload current miner config to CC Server on startup
--cc-reboot-cmd=CMD command/bat to execute to Reboot miner machine
Logging:
-S, --syslog use system log for output messages
-l, --log-file=FILE log all output to a file
--print-time=N print hashrate report every N seconds
--health-print-time=N print health report every N seconds
--no-color disable colored output
--verbose verbose output
Misc:
-c, --config=FILE load a JSON-format configuration file
-B, --background run the miner in the background
-V, --version output version information and exit
-h, --help display this help and exit
--dry-run test configuration and exit
--export-topology export hwloc topology to a XML file and exit
--pause-on-battery pause mine on battery power
--pause-on-active=N pause mine when the user is active (resume after N seconds of last activity)
--no-dmi disable DMI/SMBIOS reader
```
## Common Issues
### XMRigMiner
* XMRigMiner is just the worker, it is not designed to work standalone. Please start **XMRigDaemon** instead.
### Windows only: DLL error on starting
* Make sure that you installed latest Visual C++ Redistributable for Visual Studio 2015. Can be downloaded here: [microsoft.com](https://www.microsoft.com/de-de/download/details.aspx?id=48145)
### Linux only: Background mode
* The `--background` option will only work properly for the XMRigServer. But there is a simple workaround for the XMRigDaemon process. Just append an `&` to the command and it will run smoothly in the background.
`./xmrigDaemon --config=my_config_cc.json &` or you just use `screen`
### HUGE PAGES unavailable (Windows)
* Run XMRigDaemon as Administrator.
* On Windows it automatically enables SeLockMemoryPrivilege for current user, but reboot or sign out still required. [Manual instruction](https://msdn.microsoft.com/en-gb/library/ms190730.aspx).
### HUGE PAGES unavailable (Linux)
* Before starting XMRigDaemon set huge pages
`sudo sysctl -w vm.nr_hugepages=128`
## Donations
* Minimum 1% (1 minutes in 100 minutes) can be set via config or command line option `--donate-level`.
##### BenDroid (XMRigCC):
XMR: `4BEn3sSa2SsHBcwa9dNdKnGvvbyHPABr2JzoY7omn7DA2hPv84pVFvwDrcwMCWgz3dQVcrkw3gE9aTC9Mi5HxzkfF9ev1eH`
BTC: `3Gwq9tveCZtLAiXX7mxhjbrh38GPx1iXdB`
ETH: `0x799611a12F196848967E9002B7bF1d01872D88F8`
## Contact
* ben [at] graef.in
* [telegram](https://t.me/XMRigCC)
* [discord](https://discord.gg/r3rCKTB)
* [twitter](https://twitter.com/XMRigCC)
* [reddit](https://www.reddit.com/user/BenDr0id/)