mirror of
https://github.com/jwinterm/xmr-stak.git
synced 2026-10-17 05:41:41 +02:00
1e7911e653
Co-authored-by: psychocrypt <psychocryptHPC@gmail.com> Co-authored-by: fireice-uk <fireice-uk@users.noreply.github.com> Co-authored-by: Lee Clagett <code@leeclagett.com> Co-authored-by: curie-kief <curie-kief@users.noreply.github.com>
55 lines
2.1 KiB
Markdown
55 lines
2.1 KiB
Markdown
# HowTo Use xmr-stak
|
|
|
|
## Content Overview
|
|
* [Configuration](#configuration)
|
|
* [Usage on Windows](#usage-on-windows)
|
|
* [Usage on Linux](#usage-on-linux)
|
|
* [Command Line Options](#command-line-options)
|
|
* [HTML and JSON API report configuraton](#html-and-json-api-report-configuraton)
|
|
|
|
## 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](tuning.md)).
|
|
|
|
|
|
## Usage on Windows
|
|
1) Double click the `xmr-stak.exe` file
|
|
2) 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
|
|
1) Open a terminal within the folder with the binary
|
|
2) 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.
|
|
|
|
## 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 configuraton
|
|
|
|
To configure the reports shown on the [README](../README.md) 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
|