@@ -1,5 +1,5 @@
11# 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.
33
44
55## Download
@@ -8,49 +8,97 @@ A simple collection of bash shell scripts to manage installation, update and con
88
99### Prerequisites
1010
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)
1214* User account with sudo privileges
15+* Installed git
16+* Optionally installed [xmrig-proxy](https://github.com/xmrig/xmrig-proxy)
17+
18+### Agreeable
19+
20+Some knowledge of:
21+* Linux Command Line Interface
22+* Unix shell `bash`
23+
24+There is more to install but the install script will install the rest.
1325
1426### Installion
1527
16−1. Change in to the cloned directory
28+1. Change to your user home directory.
29+ `cd ~`
30+
31+2. Install git.
32+ `sudo apt install git`
33+
34+3. Clone this project.
35+ `git clone https://github.com/seanwhe/xmrig-bash-scripts`
36+
37+4. Change into the cloned directory.
1738 `cd xmrig-bash-scripts`
1839
19−2. Edit the settings file to your preference.
40+5. Edit the settings file to your preference.
2041 `vim settings.sh`
2142
22−3. Run the install script
43+6. Run the install script
2344 `./install.sh`
2445
25−The install script do the following:
26−1. Load the settings ensuring that your user has passwordless sudo and that vm.nr_hugepages is set.
27−2. Stop any existing screen session runing xmrig.
28−3. Run apt update, upgrade, autoremove, autoclean on system.
29−4. Install required build dependencies.
30−5. Git clone xmrig source to ~/xmrig-bash-scripts/xmrig-cpui/ and change to specified branch
31−6. Build and install xmrig to /usr/bin
32−7. Start a screen named xmrig-cpu running xmrig
46+7. Attach to the screen session created during the installation.
47+ `screen -r`
48+
49+### Operation
50+
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.
52+
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.
54+
55+This should work out the box, if you edit only the top section of `settings.sh`.
3356
34−## Viewing mining process
57+Once you have a running xmrig then you can start playing around and tweaking to suite requirements.
58+
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.
60+
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.
72+
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:
3575`screen -r xmrig-cpu`
3676
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
78+
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.
80+
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)
3884
3985## Versioning
4086
4187We 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).
4288
89+## Contributing
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.
91+
92+See also the list of [contributors](https://github.com/seanwhe/xmrig-bash-scripts/CONTRIBUTORS)
93+
4394## Authors
4495
4596* **Sean Wheller** - *Initial work* - [seanwhe](https://github.com/seanwhe)
4697
47−## CONTRIBUTING
48−See also the list of [contributors](https://github.com/seanwhe/xmrig-bash-scripts/CONTRIBUTORS
49−
5098## License
5199
52100This project is licensed under the GNU General Public License v3.0 - see the [LICENSE.md](LICENSE.md) file for details
53101
54102## Acknowledgments
55103
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/).