{"id":15146787,"url":"https://github.com/metal3d/docker-xmrig","last_synced_at":"2025-06-10T16:36:21.088Z","repository":{"id":138271799,"uuid":"214230766","full_name":"metal3d/docker-xmrig","owner":"metal3d","description":"Xmrig containeried to mine monero cryptocurrency","archived":false,"fork":false,"pushed_at":"2024-10-20T22:30:22.000Z","size":59,"stargazers_count":75,"open_issues_count":1,"forks_count":48,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-18T20:04:57.234Z","etag":null,"topics":["container","cryptocurrency","docker","monero","monero-mining","podman","xmrig"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/metal3d.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-10T16:20:33.000Z","updated_at":"2025-05-03T14:52:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"0b431fbd-4f5e-494d-a158-5681e1a464b4","html_url":"https://github.com/metal3d/docker-xmrig","commit_stats":{"total_commits":44,"total_committers":3,"mean_commits":"14.666666666666666","dds":"0.11363636363636365","last_synced_commit":"9bb5342fa6d27488b3247e0ad85734c3cd9a3676"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal3d%2Fdocker-xmrig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal3d%2Fdocker-xmrig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal3d%2Fdocker-xmrig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal3d%2Fdocker-xmrig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metal3d","download_url":"https://codeload.github.com/metal3d/docker-xmrig/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal3d%2Fdocker-xmrig/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259112375,"owners_count":22807075,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["container","cryptocurrency","docker","monero","monero-mining","podman","xmrig"],"created_at":"2024-09-26T12:04:53.650Z","updated_at":"2025-06-10T16:36:21.058Z","avatar_url":"https://github.com/metal3d.png","language":"Shell","funding_links":[],"categories":["Mining","Docker"],"sub_categories":["Other Wallets"],"readme":"# Xmrig - Monero Miner in Docker\n\n[Xmrig](https://xmrig.com/) is an open-source project for mining Monero cryptocurrency. It allows you to mine locally\nfor a pool and receive Monero for your efforts.\n\nHere, you can launch Xmrig in a Podman or Docker container and to easily run it on Kubernetes, or your local computer\nusing standard Docker commands.\n\n## Getting Started\n\nTo mine for **your wallet**, you need a Monero wallet (see [MyMonero](https://mymonero.com/)) and follow the\ninstructions below to configure the container accordingly.\n\n### Launching Xmrig\n\n```bash\ndocker run --rm -it ghcr.io/metal3d/xmrig:latest\n# podman\npodman run --rm -it ghcr.io/metal3d/xmrig:latest\n```\n\nBy default, without any options, you will mine for me, which is a way to support the project. To mine for **your wallet**,\nmodify the options using environment variables:\n\n```bash\nexport POOL_URL=\"your pool URL\"\nexport POOL_USER=\"Your public Monero address\"\nexport POOL_PASS=\"can be empty for some pools, otherwise use it as miner ID\"\nexport DONATE_LEVEL=\"Xmrig project donation in percent, default is 5\"\n\n# Update the image\ndocker pull ghcr.io/metal3d/xmrig:latest\n# or with podman\npodman pull ghcr.io/metal3d/xmrig:latest\n# Launch the Docker container\ndocker run --name miner --rm -it \\\n    -e POOL_URL=$POOL_URL \\\n    -e POOL_USER=$POOL_USER \\\n    -e POOL_PASS=$POOL_PASS \\\n    -e DONATE_LEVEL=$DONATE_LEVEL \\\n    ghcr.io/metal3d/xmrig:latest\n# or with podman\npodman run --name miner --rm -it \\\n    -e POOL_URL=$POOL_URL \\\n    -e POOL_USER=$POOL_USER \\\n    -e POOL_PASS=$POOL_PASS \\\n    -e DONATE_LEVEL=$DONATE_LEVEL \\\n    ghcr.io/metal3d/xmrig:latest\n```\n\n`DONATE_LEVEL` is **not a donation to me**, it's the donation included in the Xmrig project to support its developers.\nPlease leave it at the default value of 5 or higher to contribute to the project.\n\nPress `CTRL+C` to stop the container, and it will be automatically removed.\n\n### Environment Variables\n\n- `POOL_USER`: your wallet address (default is mine)\n- `POOL_URL`: the pool address (default is `xmr.metal3d.org:8080`)\n- `POOL_PASS`: the pool password or worker ID (default for me is \"donator\" + UUID)\n- `DONATE_LEVEL`: percentage of donation to Xmrig.com project (leave the default at 5 or higher)\n- `PRIORITY`: CPU priority (0=idle, 1=normal, 2 to 5 for higher priority)\n- `THREADS`: number of threads to start (default is number of CPU / 2)\n- `ACCESS_TOKEN`: Bearer access token to access the Xmrig API (served on port 3000, default is a generated token (UUID))\n- `ALGO`: mining algorithm (default is empty, refer to [Xmrig documentation](https://xmrig.com/docs/algorithms))\n- `COIN`: coin option instead of algorithm (default is empty)\n- `WORKERNAME`: naming the worker (generated with a random UUID if not specified)\n- `CUDA`: activate CUDA (set to \"true\"). Requires GPU sharing to containers (refer to [Nvidia documentation](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html))\n- `NO_CPU`: deactivate computation on CPU (useful for mining only on CUDA)\n\n### Using CUDA\n\nFollow instructions from [Nvidia documentation](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) and [the page for Podman using CDI](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/cdi-support.html) if you prefer Podman.\n\nTo use CUDA devices:\n\n```bash\n# Replace podman with docker if you are using Docker\npodman run --rm -it \\\n    --device nvidia.com/gpu=all \\\n    --security-opt=label=disable \\ # podman only\n    -e CUDA=true \\\n    ghcr.io/metal3d/xmrig:latest\n\n# You can compute only on GPU, but it's not recommended due to frequent GPU errors\npodman run --rm -it \\\n    --device nvidia.com/gpu=all \\\n    --security-opt=label=disable \\ # podman only\n    -e CUDA=true \\\n    -e NO_CPU=true \\\n    ghcr.io/metal3d/xmrig:latest\n```\n\n## Notes about MSR (Model Specific Registry)\n\nXmrig requires setting MSR (Model Specific Registry) to achieve optimal hashrates. If MSR is not allowed, your hashrate\nwill be low, and a warning will appear in the terminal. To enable MSR inside the container (for Podman), use the\nfollowing commands:\n\n```bash\n# Basic mining with CPU (replace podman with docker if you are using Docker)\nsudo podman run --rm -it \\\n    --privileged \\\n    ghcr.io/metal3d/xmrig:latest\n\n# To use CUDA devices\nsudo podman run --rm -it \\\n    --privileged \\\n    --device nvidia.com/gpu=all \\\n    -e CUDA=true \\\n    ghcr.io/metal3d/xmrig:latest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetal3d%2Fdocker-xmrig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetal3d%2Fdocker-xmrig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetal3d%2Fdocker-xmrig/lists"}