You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

169 lines
6.2 KiB

8 years ago
# ethminer
11 years ago
8 years ago
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)][Gitter]
[![Releases](https://img.shields.io/github/downloads/atom/atom/total.svg)][Releases]
> Ethereum miner with OpenCL, CUDA and stratum support
8 years ago
The ethminer is an Ethereum GPU mining worker. It origins in [cpp-ethereum]
project (where GPU mining has been discontinued). Then hugely improved in
[Genoil's fork].
8 years ago
### Features
8 years ago
- OpenCL mining
8 years ago
- Nvidia CUDA mining
9 years ago
- realistic benchmarking against arbitrary epoch/DAG/blocknumber
8 years ago
- on-GPU DAG generation (no more DAG files on disk)
9 years ago
- stratum mining without proxy
- OpenCL devices picking
- farm failover (getwork + stratum)
10 years ago
8 years ago
## Table of Contents
- [Install](#install)
8 years ago
- [Usage](#usage)
- [Build](#build)
- [Continuous Integration and development builds](#continuous-integration-and-development-builds)
8 years ago
- [Building from source](#building-from-source)
- [CMake configuration options](#cmake-configuration-options)
8 years ago
- [Maintainer](#maintainer)
8 years ago
- [Contribute](#contribute)
- [F.A.Q.](#faq)
## Install
[![Releases](https://img.shields.io/github/downloads/atom/atom/total.svg)][Releases]
Standalone **executables** for _Linux_, _macOS_ and _Windows_ are provided in
the [Releases] section.
8 years ago
Download an archive for your operating system and unpack the content to a place
accessible from command line. The ethminer is ready to go.
8 years ago
## Usage
The **ethminer** is a command line program. This means you launch it either
from a Windows command prompt or Linux console, or create shortcuts to
predefined command lines using a Linux Bash script or Windows batch/cmd file.
For a full list of available command, please run
```sh
ethminer --help
```
## Build
### Continuous Integration and development builds
| CI | OS | Status | Development builds |
| ------------- | ------------- | ----- | ----------------- |
| [Travis CI] | Linux, macOS | [![Travis CI](https://img.shields.io/travis/ethereum-mining/ethminer.svg)][Travis CI] | ✗ No build artifacts, [Amazon S3 is needed] for this |
| [AppVeyor] | Windows | [![AppVeyor](https://img.shields.io/appveyor/ci/ethereum-mining/ethminer.svg)][AppVeyor] | ✓ Build artifacts available for all PRs and branches |
The AppVeyor system automatically builds a Windows .exe for every commit. The latest version is always available [on the landing page](https://ci.appveyor.com/project/ethereum-mining/ethminer) or you can [browse the history](https://ci.appveyor.com/project/ethereum-mining/ethminer/history) to access previous builds.
To download the .exe on a build under 'JOB NAME' select 'Configuration: Release', choose 'ARTIFACTS' then download the zip file.
8 years ago
### Building from source
This project uses [CMake] and [Hunter] package manager.
1. Create a build directory.
```sh
mkdir build; cd build
```
2. Configure the project with CMake. Check out additional
[configuration options](#cmake-configuration-options).
```sh
cmake ..
```
3. Build the project using [CMake Build Tool Mode]. This is a portable variant
of `make`.
```sh
cmake --build .
```
4. _(Optional, Linux only)_ Install the built executable.
```sh
sudo make install
```
### CMake configuration options
Pass these options to CMake configuration command, e.g.
8 years ago
```sh
cmake .. -DETHASHCUDA=ON -DETHASHCL=OFF
8 years ago
```
- `-DETHASHCL=ON` - enable OpenCL mining, `ON` by default,
- `-DETHASHCUDA=ON` - enable CUDA mining, `OFF` by default,
- `-DETHSTRATUM=ON` - build with Stratum protocol support, `ON` by default.
8 years ago
## Maintainer
8 years ago
[![Gitter](https://img.shields.io/gitter/room/ethereum-mining/ethminer.svg)][Gitter]
8 years ago
8 years ago
- Paweł Bylica [@chfast](https://github.com/chfast)
8 years ago
8 years ago
## Contribute
8 years ago
[![Gitter](https://img.shields.io/gitter/room/ethereum-mining/ethminer.svg)][Gitter]
8 years ago
To meet the community join [the ethminer channel on Gitter][Gitter].
All bug reports, pull requests and code reviews are very much welcome.
8 years ago
## F.A.Q
8 years ago
8 years ago
1. Why is my hashrate with Nvidia cards on Windows 10 so low?
8 years ago
8 years ago
The new WDDM 2.x driver on Windows 10 uses a different way of addressing the GPU. This is good for a lot of things, but not for ETH mining.
8 years ago
For Kepler GPUs: I actually don't know. Please let me know what works best for good old Kepler.
For Maxwell 1 GPUs: Unfortunately the issue is a bit more serious on the GTX750Ti, already causing suboptimal performance on Win7 and Linux. Apparently about 4MH/s can still be reached on Linux, which, depending on ETH price, could still be profitable, considering the relatively low power draw.
8 years ago
For Maxwell 2 GPUs: There is a way of mining ETH at Win7/8/Linux speeds on Win10, by downgrading the GPU driver to a Win7 one (350.12 recommended) and using a build that was created using CUDA 6.5.
For Pascal GPUs: You have to use the latest WDDM 2.1 compatible drivers in combination with Windows 10 Anniversary edition in order to get the full potential of your Pascal GPU.
8 years ago
8 years ago
2. Why is a GTX 1080 slower than a GTX 1070?
8 years ago
8 years ago
Because of the GDDR5X memory, which can't be fully utilized for ETH mining (yet).
8 years ago
8 years ago
3. Are AMD cards also affected by slowdowns with increasing DAG size?
8 years ago
Only GCN 1.0 GPUs (78x0, 79x0, 270, 280), but in a different way. You'll see that on each new epoch (30K blocks), the hashrate will go down a little bit.
9 years ago
8 years ago
4. Can I still mine ETH with my 2GB GPU?
9 years ago
8 years ago
No.
8 years ago
5. What are the optimal launch parameters?
8 years ago
The default parameters are fine in most scenario's (CUDA). For OpenCL it varies a bit more. Just play around with the numbers and use powers of 2. GPU's like powers of 2.
11 years ago
8 years ago
[Amazon S3 is needed]: https://docs.travis-ci.com/user/uploading-artifacts/
[AppVeyor]: https://ci.appveyor.com/project/ethereum-mining/ethminer
8 years ago
[CMake]: https://cmake.org
[CMake Build Tool Mode]: https://cmake.org/cmake/help/latest/manual/cmake.1.html#build-tool-mode
8 years ago
[cpp-ethereum]: https://github.com/ethereum/cpp-ethereum
[Genoil's fork]: https://github.com/Genoil/cpp-ethereum
[Gitter]: https://gitter.im/ethereum-mining/ethminer
[Hunter]: https://docs.hunter.sh
8 years ago
[Releases]: https://github.com/ethereum-mining/ethminer/releases
8 years ago
[Travis CI]: https://travis-ci.org/ethereum-mining/ethminer