# XMRig

XMRig is a high-performance, open-source, cross-platform cryptocurrency miner that supports the RandomX, CryptoNight, KawPow, and GhostRider algorithms on both CPU and GPU. It is open source and self-hosted, installable on Docker Hub, Kubernetes (Helm), TrueNAS and Unraid.

Canonical page: https://ourlocalhost.com/app/1385/xmrig

## Description

XMRig is a high-performance, open-source, cross-platform cryptocurrency miner that supports the RandomX, CryptoNight, KawPow, and GhostRider algorithms on both CPU and GPU. Run it on your Unraid server to mine Monero (XMR) or other coins, and use the built-in RandomX benchmark to check your hardware's performance.

## Platform availability

Available on 3 of 9 platforms: Unraid, TrueNAS, Helm.

## Health score

58/100 (Fair), based on 5 of 5 factors.
- Maintained: 52 (last commit 209 days ago)
- Popular: 80 (10,143 GitHub stars)
- Easy to install: 55 (3 install platforms, install notes, Docker image)
- Light to run: 30 (2.03125 GB minimum RAM)
- Security check: 65 (no serious findings, tests, OpenSSF Scorecard 3.6/10)

## Links

- Documentation: https://xmrig.com/docs/api
- Docker Hub: https://hub.docker.com/r/lnxd/xmrig
- Kubernetes (Helm): https://artifacthub.io/packages/helm/brannon/xmrig
- TrueNAS: https://apps.truenas.com/catalog/xmrig/
- Official website: https://xmrig.com
- Unraid: https://ca.unraid.net/apps/xmrig-11q3qn502iyxy5?q=XMRig
- GitHub: https://github.com/xmrig/xmrig

## Common questions

### What do I need to replace in the config before starting XMRig?

Set the example pool URL and wallet address to your real pool and wallet, and choose the algorithm or coin that the pool expects. If these values are missing or wrong, the pool may reject work or you may mine nothing.

### Should I expose the XMRig API port?

Only enable the API if you need the local web control interface. Set http.enabled to true, choose a port, and add an access token, because an unprotected API can let other devices on your network control the miner.

### How can I check that XMRig is using my CPU correctly before joining a pool?

Add "benchmark": "1M" to your config to measure performance before sending work to a pool. This helps confirm the miner is using your hardware correctly and avoids wasting time on a misconfigured pool.

---
Source: Our Local Host (https://ourlocalhost.com/app/1385/xmrig), the self-hosted and open-source app directory.