@@ -1,5 +1,5 @@
1# xmrig-bash-scripts
1# xmrig-bash-scripts
2−A simple collection of bash shell scripts to manage installation, update and configuration of [xmrig cpu](https://github.com/xmrig/xmrig) across multiple hosts.
2+A set of convenience scripts, written in bash, to help manage installation, configuration and update of [xmrig cpu](https://github.com/xmrig/xmrig) across multiple hosts.
@@ -8,49 +8,97 @@ A simple collection of bash shell scripts to manage installation, update and con
9### Prerequisites
9### Prerequisites
11−* Ubuntu Linux (or other Debian-based distribution)
11+There is allot to install so the install script will do most of the heavy lifting.
12+At the start the expectation is that you have:
13+* Computer running Ubuntu 18.04 (LTS)
12* User account with sudo privileges
14* User account with sudo privileges
16+* Optionally installed [xmrig-proxy](https://github.com/xmrig/xmrig-proxy)
21+* Linux Command Line Interface
24+There is more to install but the install script will install the rest.
14### Installion
26### Installion
28+1. Change to your user home directory.
32+ `sudo apt install git`
34+3. Clone this project.
35+ `git clone https://github.com/seanwhe/xmrig-bash-scripts`
16−1. Change in to the cloned directory
37+4. Change into the cloned directory.
17 `cd xmrig-bash-scripts`
38 `cd xmrig-bash-scripts`
19−2. Edit the settings file to your preference.
40+5. Edit the settings file to your preference.
20 `vim settings.sh`
41 `vim settings.sh`
22−3. Run the install script
43+6. Run the install script
23 `./install.sh`
44 `./install.sh`
25−The install script do the following:
46+7. Attach to the screen session created during the installation.
26−1. Load the settings ensuring that your user has passwordless sudo and that vm.nr_hugepages is set.
47+ `screen -r`
27−2. Stop any existing screen session runing xmrig.
48+
28−3. Run apt update, upgrade, autoremove, autoclean on system.
49+### Operation
29−4. Install required build dependencies.
50+
30−5. Git clone xmrig source to ~/xmrig-bash-scripts/xmrig-cpui/ and change to specified branch
51+With the exception of the 'xmrig' binary, which is installed to `/usr/bin/xmrig`, all files remain in the cloned project directory `~/xmrig-bash-scripts`. Any files generated while running the scripts are created in this directory.
31−6. Build and install xmrig to /usr/bin
52+
32−7. Start a screen named xmrig-cpu running xmrig
53+During install the folder source for [xmrig cpu](https://github.com/xmrig/xmrig) is cloned to `xmrig-cpu/`in the path. The `config.json` is also created in this path.
55+This should work out the box, if you edit only the top section of `settings.sh`.
57+Once you have a running xmrig then you can start playing around and tweaking to suite requirements.
59+What follows is a brief of the shell scripts you will find. The names are mostly self explanatory. Comments and notes are used liberally in the scripts to help give you hints as to how it works. The scripts are designed to be modular to promote resuse, execute exclusion and standalone execution.
61+* build.sh - clones xmrig to ``~/xmrig-bash-scripts`/xmrig-cpu`, configures, builds and copies xmrig to `/usr/bin/`
62+* config.sh - contains variables that aid in defining the values for the attributes found in config.json.
63+* crontab.sh - installs a cron to start and a cron to stop at specific times (Can be commented out of install if desired).
64+* depends.sh - installs dependancies required by xmrig and these scripts.
65+* functions.sh - a collection of functions used in various of the scripts.
66+* install.sh - the main entry point when first installing.
67+* maintenance.sh - performs apt update and upgrade.
68+* settings.sh - contains variables used by these scripts.
69+* start.sh - starts xmrig in a screen session.
70+* stop.sh - stops xmrig screen session.
71+* update.sh - updates and existing installation.
34−## Viewing mining process
73+### Viewing the log
74+Default of the start script is to create a screen session named 'xmrig-cpu'. This can be changed in the settings script if required. To view the log after installation is finished or after running the start script, used the following command:
35`screen -r xmrig-cpu`
75`screen -r xmrig-cpu`
37−Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
77+## Reporting issues
79+[xmrig cpu](https://github.com/xmrig/xmrig) and [xmrig bash scripts](https://github.com/seanwhe/xmrig-bash-scripts.git) are different projects run by different people.
81+While the developers of both projects may be seen interacting with one another on either project, we ask that you report issues to the respective projects. In other words, post issues for:
82+* xmrig, the Monero (XMR) CPU miner, over at [xmrig issues tracker](https://github.com/xmrig/xmrig/issues)
83+* xmrig-bash-scripts, these conveniece scripts, over at [xmrig-bash-scripts](https://github.com/seanwhe/xmrig-bash-scripts/issues)
39## Versioning
85## Versioning
41We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/seanwhe/xmrig-bash-scripts/tags).
87We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/seanwhe/xmrig-bash-scripts/tags).
90+Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
92+See also the list of [contributors](https://github.com/seanwhe/xmrig-bash-scripts/CONTRIBUTORS)
45* **Sean Wheller** - *Initial work* - [seanwhe](https://github.com/seanwhe)
96* **Sean Wheller** - *Initial work* - [seanwhe](https://github.com/seanwhe)
48−See also the list of [contributors](https://github.com/seanwhe/xmrig-bash-scripts/CONTRIBUTORS
52This project is licensed under the GNU General Public License v3.0 - see the [LICENSE.md](LICENSE.md) file for details
100This project is licensed under the GNU General Public License v3.0 - see the [LICENSE.md](LICENSE.md) file for details
54## Acknowledgments
102## Acknowledgments
56−* Thanks to [fireice-uk](https://github.com/fireice-uk) for developing and maintaining xmrig
104+* Thanks to [fireice-uk](https://github.com/fireice-uk) for developing and maintaining [xmrig products](https://xmrig.com/).