{"id":20443920,"url":"https://github.com/jonas-merkle/container-xmr-mining","last_synced_at":"2026-04-21T05:34:19.636Z","repository":{"id":142777641,"uuid":"588596713","full_name":"jonas-merkle/container-xmr-mining","owner":"jonas-merkle","description":"A Docker container setup to mine XMR based on XMRig","archived":false,"fork":false,"pushed_at":"2025-02-02T12:48:40.000Z","size":52,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-05T08:25:21.758Z","etag":null,"topics":["docker","docker-compose","docker-image","xmr","xmrig"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jonas-merkle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"jonas-merkle","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-01-13T14:11:12.000Z","updated_at":"2024-12-18T13:38:37.000Z","dependencies_parsed_at":"2025-01-15T20:06:44.258Z","dependency_job_id":"f4576a8d-34d1-403d-bc9d-721df743f35f","html_url":"https://github.com/jonas-merkle/container-xmr-mining","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/jonas-merkle/container-xmr-mining","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonas-merkle%2Fcontainer-xmr-mining","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonas-merkle%2Fcontainer-xmr-mining/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonas-merkle%2Fcontainer-xmr-mining/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonas-merkle%2Fcontainer-xmr-mining/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonas-merkle","download_url":"https://codeload.github.com/jonas-merkle/container-xmr-mining/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonas-merkle%2Fcontainer-xmr-mining/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32079057,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T02:38:07.213Z","status":"ssl_error","status_checked_at":"2026-04-21T02:38:06.559Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["docker","docker-compose","docker-image","xmr","xmrig"],"created_at":"2024-11-15T09:49:56.264Z","updated_at":"2026-04-21T05:34:19.608Z","avatar_url":"https://github.com/jonas-merkle.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/jonas-merkle"],"categories":[],"sub_categories":[],"readme":"# container-xmr-mining\n\nA Docker container setup for mining Monero (XMR) using [XMRig](https://github.com/xmrig). This repository provides a simple Docker and Docker Compose setup to facilitate a fast and efficient mining experience.\n\n## Table of Contents\n\n- [container-xmr-mining](#container-xmr-mining)\n  - [Table of Contents](#table-of-contents)\n  - [Requirements](#requirements)\n  - [Setup](#setup)\n    - [Using only the Docker image](#using-only-the-docker-image)\n    - [Using Docker Compose](#using-docker-compose)\n      - [Configuration](#configuration)\n  - [Running the Project](#running-the-project)\n  - [Security Notes](#security-notes)\n  - [License](#license)\n\n## Requirements\n\n- Docker\n- Docker Compose\n\n## Setup\n\n### Using only the Docker image\n\n1. Pull the Docker image:\n\n    ```sh\n    docker pull ghcr.io/jonas-merkle/container-xmr-mining:latest\n    ```\n\n2. Run the Docker container:\n\n    ```sh\n    docker run -d --name xmr-miner -v $(pwd)/config:/miner-config:ro ghcr.io/jonas-merkle/container-xmr-mining:latest\n    ```\n\n### Using Docker Compose\n\n1. Clone the repository:\n\n    ```sh\n    git clone https://github.com/jonas-merkle/container-xmr-mining.git\n    cd container-xmr-mining\n    ```\n\n2. Copy the demo configuration file:\n\n    ```sh\n    cp ./config/config_demo.json ./config/config.json\n    ```\n\n3. Edit the `config.json` file to suit your needs:\n\n    ```sh\n    nano ./config/config.json\n    ```\n\n4. Start the Docker Compose setup:\n\n    ```sh\n    docker-compose up -d\n    ```\n\n#### Configuration\n\nThe XMRig tool must be configured before the first run. Follow these steps to set up the tool:\n\n1. Copy the Demo Configuration File:\n\n    ```sh\n    cp ./config/config_demo.json ./config/config.json\n    ```\n\n2. Edit the Configuration File:\n    Open the `config.json` file in your preferred text editor:\n\n    ```sh\n    nano ./config/config.json\n    ```\n\n3. Essential Configuration Settings:\n    - Pool Information:\n\n        ```json\n        \"url\": \"pool.minexmr.com:4444\"\n        ```\n\n    - Wallet Address:\n\n        ```json\n        \"user\": \"YOUR_WALLET_ADDRESS\"\n        ```\n\n4. Advanced Configuration Options:\n    - Worker ID (Optional):\n\n        ```json\n        \"rig-id\": \"my-miner-01\"\n        ```\n\n    - Algorithm Selection:\n\n        ```json\n        \"algo\": \"rx/0\"\n        ```\n\n    - Threads Configuration:\n\n        ```json\n        \"threads\": 4\n        ```\n\n    - Background Mode:\n\n        ```json\n        \"background\": true\n        ```\n\n    - Max CPU Usage:\n\n        ```json\n        \"max-cpu-usage\": 75\n        ```\n\n    - Donate Level:\n\n        ```json\n        \"donate-level\": 1\n        ```\n\n5. Logging and Monitoring:\n    - Log File:\n\n        ```json\n        \"log-file\": \"/miner-config/xmrig.log\"\n        ```\n\n    - Print Time Interval:\n\n        ```json\n        \"print-time\": 60\n        ```\n\n6. Tuning for Optimal Performance:\n    - Huge Pages:\n\n        ```json\n        \"huge-pages\": true\n        ```\n\n    - Affinity:\n\n        ```json\n        \"cpu-affinity\": [0, 2, 4, 6]\n        ```\n\nFor more detailed information on configuring XMRig, refer to the [XMRig Configuration Guide](./doc/XMRig-Configuration-Guide.md). Configuration\n\nThe XMRig tool must be configured before the first run. Have a look at the short [documentation](./doc/XMRig-Configuration-Guide.md) on how to set up the tool.\n\n## Running the Project\n\n1. Ensure Docker and Docker Compose are installed on your system.\n\n2. Clone the repository and navigate to the project directory:\n\n    ```sh\n    git clone https://github.com/jonas-merkle/container-xmr-mining.git\n    cd container-xmr-mining\n    ```\n\n3. Copy and edit the configuration file:\n\n    ```sh\n    cp ./config/config_demo.json ./config/config.json\n    nano ./config/config.json\n    ```\n\n4. Start the Docker Compose setup:\n\n    ```sh\n    docker-compose up -d\n    ```\n\n5. Check the logs to ensure the miner is running correctly:\n\n    ```sh\n    docker-compose logs -f\n    ```\n\n## Security Notes\n\n- **Environment Variables**: Ensure that `.env` files are not shared or tracked in version control, as they may contain sensitive information such as API tokens or credentials.\n- **Sensitive Files**: Always keep sensitive files like `.env` secure and ensure they are not exposed publicly.\n\n## License\n\nThis project is licensed under the [**GNU Lesser General Public License v3.0**](https://www.gnu.org/licenses/lgpl-3.0.html) (LGPLv3).\nIt is distributed \"as is\", without warranty of any kind.\nYou are free to use, modify, and distribute this software under the terms specified in the LGPLv3.\n\nSee the [LICENSE](./LICENSE) file for more detailed information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonas-merkle%2Fcontainer-xmr-mining","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonas-merkle%2Fcontainer-xmr-mining","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonas-merkle%2Fcontainer-xmr-mining/lists"}