XMRStak — Complete Guide
Start Mining
Miner has 2 ways of initial configuring: simple and advanced.
The simple method will prompt user with minimum information. Required answers are y , (or yes), n , (or no):
Simple setup:
Use simple setup method? y
Please enter the currency that you want to mine: Enter currency or mining algorithm
Enter pool address (pool address:port): Enter pool connection address:port
Username (wallet address or pool login): Enter wallet address
Password (mostly empty or x): press Enter
Does this pool port support TLS/SSL? Use no if unknown. (y/N): press y or n
Advanced setup:
Use simple setup method? n
Do you want to use the HTTP interface? Unlike the screen display, browser interface is not affected by the GPU lag. If you don't want to use it, please enter 0, otherwise enter port number that the miner should listen on 5656
Please enter the currency that you want to mine: Enter currency or mining algorithm
Enter pool address (pool address:port): Enter pool connection address:port
Username (wallet address or pool login): Enter wallet address
Password (mostly empty or x): press Enter
Rig identifier for pool-side statistics (needs pool support). Can be empty: Enter rig name or press Enter
Does this pool port support TLS/SSL? Use no if unknown. (y/N) Enter y or n
Do you want to use nicehash on this pool? (y/N) n
Do you want to use multiple pools? (y/N) Enter y if you want to se up backup pool or n
Configurations
Before you started the miner the first time there are no config files available. Config files will be created at the first start. The number of files depends on the available backends. config.txt contains the common miner settings. pools.txt contains the selected mining pools and currency to mine. amd.txt, cpu.txt and nvidia.txt contains miner backend specific settings and can be used for further tuning (Tuning Guide).
Note: If the pool is ignoring the option rig_id in pools.txt to name your worker please check the pool documentation how a worker name can be set.
Usage on Windows
Double click the xmr-stak.exe file
Fill in the pool url settings, currency, username and password
set XMRSTAK_NOWAIT=1 disable the dialog Press any key to exit. for non UAC execution.
Usage on Linux & macOS
Open a terminal within the folder with the binary
Start the miner with ./xmr-stak
Command Line Options
The miner allow to overwrite some of the settings via command line options. Run xmr-stak --help to show all available command line options.
Use Different Backends
On linux and OSX please add ./ before the binary name xmr-stak.
CPU Only:
xmr-stak --noAMD --noNVIDIA
NVIDIA/AMD Only:
The miner will automatically detect if CUDA (for NVIDIA GPUs) or OpenCL (for AMD GPUs) is available.
xmr-stak --noCPU
NVIDIA via OpenCL
It is possible to use the OpenCl backend which is originally created for AMD GPUs with NVIDIA GPus. Some NVIDIA GPUs can reach better performance with this backend.
xmr-stak --openCLVendor NVIDIA --noNVIDIA
Docker image usage
You can run the Docker image the following way:
docker run --rm -it -u $(id -u):$(id -g) --name fireice-uk/xmr-stak -v "$PWD":/mnt xmr-stak
docker stop xmr-stak
docker run --rm -it -u $(id -u):$(id -g) --name fireice-uk/xmr-stak -v "$PWD":/mnt xmr-stak --config config.txt
Debug the docker image by getting inside:
docker run --entrypoint=/bin/bash --rm -it -u $(id -u):$(id -g) --name fireice-uk/xmr-stak -v "$PWD":/mnt xmr-stak
HTML and JSON API report configuration
To configure the reports shown on the README side you need to edit the httpd_port variable. Then enable wifi on your phone and navigate to [miner ip address]:[httpd_port] in your phone browser. If you want to use the data in scripts, you can get the JSON version of the data at url [miner ip address]:[httpd_port]/api.json
