summaryrefslogtreecommitdiffstats
path: root/doc/usage.md
diff options
context:
space:
mode:
authorpsychocrypt <psychocrypt@users.noreply.github.com>2017-11-27 20:55:11 +0100
committerGitHub <noreply@github.com>2017-11-27 20:55:11 +0100
commit8d74342ca6d34b441c7118e2ab70a4b9c6ec01de (patch)
treea493b6bea42a9f6d604bcc28ddadac0339d8e581 /doc/usage.md
parent52d9ee6ab7fc28e67936cf09d54bb10b0c5f6f9f (diff)
parent13b07fff1849bd75310a362659110b2ff85318c2 (diff)
downloadxmr-stak-8d74342ca6d34b441c7118e2ab70a4b9c6ec01de.zip
xmr-stak-8d74342ca6d34b441c7118e2ab70a4b9c6ec01de.tar.gz
Merge pull request #215 from ruzickap/feature/dockerfile
Adding Dockerfile and fixing build_xmr-stak_docker script
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 60825b4..a13586f 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