diff options
author | fireice-uk <fireice-uk@users.noreply.github.com> | 2017-11-18 21:57:37 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-11-18 21:57:37 +0000 |
commit | 27e511a1e92e903414e176161925d87165cbe25f (patch) | |
tree | 162ceceb30b0f52b915efdafc68b386330dcac5b | |
parent | 36079b9311a3e21502869360b6a2cbb530a99a1a (diff) | |
parent | fd38122c2f658694010e14ba97a067ca7700a7b2 (diff) | |
download | xmr-stak-27e511a1e92e903414e176161925d87165cbe25f.zip xmr-stak-27e511a1e92e903414e176161925d87165cbe25f.tar.gz |
Merge pull request #135 from fireice-uk/topic-doc-ext
Update docs
-rw-r--r-- | README.md | 3 | ||||
-rw-r--r-- | doc/Linux_deployment.md | 24 |
2 files changed, 27 insertions, 0 deletions
@@ -1,3 +1,4 @@ +###### fireice-uk's and psychocrypt's # XMR-Stak - Monero/Aeon All-in-One Mining Software XMR-Stak is a universal Stratum pool miner. This miner supports CPUs, AMD and NVIDIA gpus and can be used to mine the crypto currency Monero and Aeon. @@ -8,6 +9,7 @@ XMR-Stak is a universal Stratum pool miner. This miner supports CPUs, AMD and NV ## Overview * [Features](#features) * [Download](#download) +* [Linux Portable Binary](doc/Linux_deployment.md) * [Usage](doc/usage.md) * [HowTo Compile](doc/compile.md) * [FAQ](doc/FAQ.md) @@ -30,6 +32,7 @@ XMR-Stak is a universal Stratum pool miner. This miner supports CPUs, AMD and NV ## Download You can find the latest releases and precompiled binaries on GitHub under [Releases](https://github.com/xmr-stak/xmr-stak/releases). +If you are running on Linux (especially Linux VMs), checkout [Linux Portable Binary](doc/Linux_deployment.md). ## Default Developer Donation diff --git a/doc/Linux_deployment.md b/doc/Linux_deployment.md new file mode 100644 index 0000000..caf762c --- /dev/null +++ b/doc/Linux_deployment.md @@ -0,0 +1,24 @@ +# Deploying portable **XMR-Stak** on Linux systems + +XMR-Stak releases include a pre-built portable version. If you are simply using it to avoid having to compile the application, you can simply download **xmr-stak-portbin-linux.tar.gz** from our [latest releases](https://github.com/fireice-uk/xmr-stak/releases/latest). Open up command line, and use the following commands: + +``` +tar xzf xmr-stak-portbin-linux.tar.gz +./xmr-stak.sh +``` + +Configuration and tuning files will be generated automatically from your answers. + +For automatic deployments, please use the steps above to obtain config.txt and use the following script: + +``` +#!/bin/bash +curl -O `curl -s https://api.github.com/repos/fireice-uk/xmr-stak/releases/latest | grep -o 'browser_download_url.*xmr-stak-portbin-linux.tar.gz' | sed 's/.*"//'` +curl -O http://path.to/your/config.txt +tar xzf xmr-stak-portbin-linux.tar.gz +./xmr-stak.sh +``` + +XMR-Stak will auto-configure and go to work. You don't even need Docker! + + |