2A 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.
6* https://github.com/seanwhe/xmrig-bash-scripts
7* Git clone with `git clone https://github.com/seanwhe/xmrig-bash-scripts`
11There is allot to install so the install script will do most of the heavy lifting.
12At the start the expectation is that you have:
13* Computer running Ubuntu 18.04 (LTS)
15* User account with sudo privileges
17* Optionally installed [xmrig-proxy](https://github.com/xmrig/xmrig-proxy)
22* Linux Command Line Interface
271. Change to your user home directory.
30 `sudo apt install git`
32 `git clone https://github.com/seanwhe/xmrig-bash-scripts`
331. Change into the cloned directory.
34 `cd xmrig-bash-scripts`
351. Run the install script
371. When prompted: "Enter your own settings?" enter 'y'es.
381. Enter values for your:
40 1. Pool server TCP port
41 1. Receive wallet address
43 1. Miner identifier name
441. After install is complete. Attach to the screen session created during the installation.
49Defaults - The settings.sh contains a number of variables. 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 also created in this directory.
51During install the folder source for [xmrig cpu](https://github.com/xmrig/xmrig) is cloned to `~/xmrig-bash-scripts/xmrig-cpu/`. The file `config.json`, used to configure xmrig, is also created in this path and is passed to xmrig at startup.
53During installation it is recomended to enter your own settings. This creates a file named 'mysettings.sh' which will not be overwritten during future installs or upgrades. Values for variables found in 'mysettings.sh' are used to create 'config.json'.
55This should work out the box, if you follow the installation steps and enter your own values for 'mysettings.sh.
57Once you have a running xmrig then you can start playing around and tweaking to suite requirements.
59What follows is a brief of the shell scripts you will find. The names are mostly self explanatory.
60Comments and notes are used liberally in the scripts to help give you hints as to how it works.
61The scripts are designed to be modular to promote resuse, execute exclusion and standalone execution.
63* build.sh - clones xmrig to ``~/xmrig-bash-scripts`/xmrig-cpu`, configures, builds and copies xmrig to `/usr/bin/`
64* config.sh - contains variables that aid in defining the values for the attributes found in config.json.
65* crontab.sh - installs a cron to start and a cron to stop at specific times (Can be commented out of install if desired).
66* crontab-off - removed the users crontab created during install.
67* crontab-on.sh - redefines the users crontab as created during install.
68* depends.sh - installs dependancies required by xmrig and these scripts.
69* functions.sh - a collection of functions used in various of the scripts.
70* input.sh - prompts to enter values for creating 'mysettings.sh'
71* install.sh - the main entry point when first installing.
72* maintenance.sh - performs apt update, upgrade, autoremove and autoclean operations.
73* settings.sh - contains variables used by these scripts.
74* start.sh - starts xmrig in a screen session.
75* stop.sh - stops xmrig screen session.
78Default of the start script is to create a screen session named 'xmrig-cpu'.
79This can be changed in the settings script if required.
80To view the log after installation is finished or after running the start script, used the following command:
84A simple `git update` in `~/xmrig-bash-scripts` will update these scripts.
86The install script can be run at any time to update the xmrig source found `~/xmrig-bash-scripts/xmrig-cpu`.
87The branch checkout is taken from the `_XMRIG_BRANCH` variable in `settings.sh`.
89A script named update.sh is provided to perform both these steps in a single command.
93[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.
95While 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.
96In other words, post issues for:
97* xmrig, the Monero (XMR) CPU miner, over at [xmrig issues tracker](https://github.com/xmrig/xmrig/issues)
98* xmrig-bash-scripts, these conveniece scripts, over at [xmrig-bash-scripts](https://github.com/seanwhe/xmrig-bash-scripts/issues)
102We 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).
105Please 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.
107See also the list of [contributors](https://github.com/seanwhe/xmrig-bash-scripts/CONTRIBUTORS)
111* **Sean Wheller** - *Initial work* - [seanwhe](https://github.com/seanwhe)
115This project is licensed under the GNU General Public License v3.0 - see the [LICENSE.md](LICENSE.md) file for details
119* Thanks to [fireice-uk](https://github.com/fireice-uk) for developing and maintaining [xmrig products](https://xmrig.com/).
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list