Monero (XMR) CPU miner packaged in a lightweight Docker image that you can easily deploy to a Kubernetes cluster.
XMRig is a high performance, open source, cross platform RandomX, KawPow, CryptoNight and AstroBWT unified CPU/GPU miner and RandomX benchmark. It supports Monero, among other cryptocurrencies.
This Docker image was built with the latest XMRig version from source on Alpine Linux and it is only 16 MB in size. It's rootless, immutable, and supports your own donate level and timezone. You can easily deploy it as a standalone Docker container, or to a Kubernetes cluster in minutes.
- Maintained by: Roberto Meléndez
- Supported architectures:
amd64
,arm32v7
,arm64v8
- Supported tags:
latest
,6.17.0
,6.16.4
,6.16.3
,6.16.2
Step 1: Clone the GitHub repo:
$ git clone https://github.com/rcmelendez/xmrig-docker.git
Step 2: Edit the config.json
file. Provide your pool, wallet address, and coin to mine. If you are feeling generous, set the donate-level
greater than 0:
"coin": "XMR",
"url": "gulf.moneroocean.stream:10128",
"user": "43BFSy88EBK7pstEvSkxp2BpnDYj2xP4PG4sf1MSywj2EDdF1WYyTysRGZFAh639zyKyZYzshQwQ4CELq9d76wob3zwfGuc",
"donate-level": 0,
For all the available options, visit XMRig Config File documentation.
Step 3: Deploy the image as a standalone Docker container or to a Kubernetes cluster.
$ docker run -dit --rm \
--volume "$(pwd)"/config.json:/xmrig/etc/config.json:ro \
--volume "$(pwd)"/log:/xmrig/log \
--name xmrig rcmelendez/xmrig \
xmrig --config=/xmrig/etc/config.json
If you prefer Docker Compose, edit the docker-compose.yml
manifest as needed and run:
$ docker-compose up -d
Step 1: Create a namespace for our XMRig application (optional but recommended):
$ kubectl create ns xmrig
Step 2: Create a configmap in the new namespace xmrig
from the config.json
file:
$ kubectl create configmap xmrig-config --from-file config.json -n xmrig
Step 3: Edit the xmrig.yaml
file. Things you may want to modify include:
replicas
: number of desired pods to be running.image:tag
: to view all available versions, go to the Tags tab of the Docker Hub repo.resources
: set appropriate values forcpu
andmemory
requests/limits.affinity
: the manifest will schedule only one pod per node, if that's not the desired behavior, remove theaffinity
block.
Step 4: Once you are satisfied with the above manifest, create a deployment:
$ kubectl -f apply xmrig.yaml
This Docker image sends the container logs to the stdout
. To view the logs, run:
$ docker logs xmrig
For Kubernetes run:
$ kubectl logs -n xmrig <pod-name>
Containers are stateless by nature, so their logs will be lost when they shut down. If you want the logs to persist, enable XMRig syslog output in the config.json
file:
"syslog": true,
"log-file": "/xmrig/log/xmrig.log",
And give full permissions to the directory on the host machine:
$ chmod 777 "$(pwd)"/log
Then use either Docker bind mounts or Kubernetes Persistent Volumes to keep the log file on the host machine. The docker run
command above and the docker-compose.yml
file already includes this mapping.
None of this can be considered financial advice. Do your own research and mine the cryptocurrencies that you prefer. I'm a tech enthusiast with foundational knowledge of Docker and Kubernetes. This project was inspired by my curiosity to start learning about the cryptocurrency world and by the drive to keep improving my tech skills. Will I or you become rich by using XMRig? I don't think so. Will be it fun? Yeah. Will you learn? A lot!
The Docker image is licensed under the terms of the MIT License. XMRig is licensed under the GNU General Public License v3.0. See its LICENSE
file for details.