summaryrefslogtreecommitdiffstats
path: root/doc/usage.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/usage.md')
-rw-r--r--doc/usage.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/usage.md b/doc/usage.md
index bb35769..9cbbdd4 100644
--- a/doc/usage.md
+++ b/doc/usage.md
@@ -49,6 +49,22 @@ The Following options temporary overwrites the config file settings:
-p, --pass PASSWD pool password, in the most cases x or empty ""
```
+## 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
OpenPOWER on IntegriCloud