https://github.com/thelolagemann/docker-gminer
a docker container for running gminer
https://github.com/thelolagemann/docker-gminer
cryptocurrency cryptocurrency-mining cryptomining cuckoocycle cuda docker dual-mining equihash ethash ethereum ethereum-miner ethereum-mining gminer kawpow miner mining nvidia progpow ton
Last synced: 5 months ago
JSON representation
a docker container for running gminer
- Host: GitHub
- URL: https://github.com/thelolagemann/docker-gminer
- Owner: thelolagemann
- License: mit
- Created: 2021-08-24T22:44:33.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T10:43:57.000Z (over 1 year ago)
- Last Synced: 2025-03-11T08:37:58.189Z (over 1 year ago)
- Topics: cryptocurrency, cryptocurrency-mining, cryptomining, cuckoocycle, cuda, docker, dual-mining, equihash, ethash, ethereum, ethereum-miner, ethereum-mining, gminer, kawpow, miner, mining, nvidia, progpow, ton
- Language: Dockerfile
- Homepage:
- Size: 76.2 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docker-gminer
A docker container for quickly getting up and running with gminer.
## Table of Contents
* [Requirements](#Requirements)
* [AMD](#amd)
* [NVIDIA](#nvidia)
* [Quick Start](#quick-start)
* [Environment Variables](#environment-variables)
* [Docker Compose](#docker-compose)
* [Building](#building)
## Requirements
### AMD
AMD GPUs are currently unsupported. See issue [#1](https://github.com/thelolagemann/docker-gminer/issues/1)
### NVIDIA
* [nvidia-drivers](https://www.nvidia.com/en-us/drivers/unix/) >= 418.81.07
* [nvidia-docker2](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker)
#### CUDA
Ensure you have the correct nvidia-drivers installed, and then run `nvidia-smi` in order to check your currently
supported CUDA version. For example, 11.6 => `thelolagemann/gminer:latest-cuda-11.6.1`. Currently, images are
automatically generated on each new gminer release, for CUDA versions
- 11.6.1
- 12.3.2
- 12.6.3
## Quick start
**NOTE**: The command provided is an example and should be adjusted for your needs.
Launch the miner with the following command:
```bash
docker run -d \
--name="gminer" \
--gpus=all \
--runtime=nvidia \
-e WALLET_ADDRESS="88yUzYzB9wrR2r2o1TzXxDMENr6Kbadr3caqKTBUNFZ3dWVt6sJcpWBAwMwNRtEi7nHcBcqzmExNfdNK7ughaCeUFuXXpPp" \
-e MINING_ALGO="etchash" \
-e MINING_POOL="gulf.moneroocean.stream:11024" \
--restart=always \
thelolagemann/gminer:latest-cuda-12.6.3
```
| **Parameter** | **Description** |
|---------------|----------------------------------------------------------------------------------------------------------------------------------|
| `-d` | Run the container in the background. If not set, the container runs in the foreground. |
| `-e` | Pass an environment variable to the container. See the [Environment Variables](#environment-variables) section for more details. |
## Environment variables
| **Variable** | **Description** | **Default** |
|-------------------|--------------------------------------------|--------------------------------------|
| `RIG_NAME` | Name used to identify the mining rig. | Randomly generated |
| `WALLET_ADDRESS` | The wallet to payout to. | (unset) |
| `MINING_ALGO` | Mining algo to use. | `etchash` |
| `MINING_POOL` | URL of the mining pool to connect to. | `gulf.moneroocean.stream:11024` |
| `DMINING_ALGO` | Dual mining algo to use | `ton` |
| `DMINING_POOL` | URL of the dual mining pool to connect to. | `wss://pplns.toncoinpool.io/stratum` |
| `DWALLET_ADDRESS` | The wallet to payout to for dual mining. | (unset) |
## Docker Compose
Here is an example of a `docker-compose.yml` file that can be used with [docker-compose](https://docs.docker.com/compose).
**NOTE**: Make sure to adjust the configuration according to your needs.
```yaml
version: "3.9"
services:
gminer:
image: thelolagemann/gminer:latest-cuda-12.6.3
environment:
MINING_ALGO: "etchash"
MINING_POOL: "gulf.moneroocean.stream:11024"
RIG_NAME: "gpu~etchash"
WALLET_ADDRESS: "88yUzYzB9wrR2r2o1TzXxDMENr6Kbadr3caqKTBUNFZ3dWVt6sJcpWBAwMwNRtEi7nHcBcqzmExNfdNK7ughaCeUFuXXpPp"
deploy:
resources:
reservations:
devices:
- driver: nvidia
count: 1
capabilities: [gpu]
```
## Building
In order to build the container run the command.
```shell
docker build .
```
When building docker containers, you can pass build arguments with the `--build-arg` flag. Listed below are the available
build arguments you can pass during build.
| Argument | Description | Default |
|------------------|----------------------------------------------------------|----------|
| `GMINER_VERSION` | The version of gminer to build the container with. | `3.44` |
| `CUDA_BASE` | The version of CUDA to build the container with. | `12.6.3` |
| `UBUNTU_VERSION` | Ubuntu OS base container version.[1](#ubuntu) | `20.04` |
1: Check NVIDIA's [dockerhub](https://hub.docker.com/r/nvidia/cuda/tags?page=1&name=-runtime-ubuntu)
to correctly match up the CUDA and Ubuntu versions.
For example, to build a container with cuda version 12.6.3 and gminer 3.44, run the command
```shell
docker build --build-arg GMINER_VERSION=3.44 --build-arg CUDA_BASE=12.6.3 .
```
## License
This project is licensed under the MIT license - see the [LICENSE](https://github.com/thelolagemann/docker-gminer/blob/main/LICENSE) file for details