Launching from command line
A batch/shell file can be created to launch nanominer with command line arguments. This file must call the cmdline_launcher script (cmdline_launcher.bat on Windows, cmdline_launcher.sh on Linux), which converts the command line into a config called config_cmdline.ini and launches the miner with it. At least one algorithm and wallet must be passed to the cmdline_launcher script. All common config parameters in the command line must be specified before the first "algo" parameter. Here are some examples of command lines for launching Ethereum Classic:
Windows
cmdline_launcher -algo etchash -wallet YOUR_ETC_WALLET -coin etc -rigName YOUR_ETC_WORKER -email YOUR_EMAIL
Linux
./cmdline_launcher.sh -algo etchash -wallet YOUR_ETC_WALLET -coin etc -rigName YOUR_ETC_WORKER -email YOUR_EMAIL
Log Files
The event log function on nanominer is automatically activated each time the program starts up. The log files that are created contain all the information displayed on the console while the miner is running. By default, the log files are saved in the logs folder of the program's current directory. Deactivating event logging, as well as assigning a random catalogue for recording log files, can be done by using the corresponding configuration parameters (see the examples in the Parameters section of this file).
noLog |
Optional common parameter. This parameter accepts the values true or false (the default is false). If this parameter is set to true then no log files will be recorded onto the hard drive.
|
noColor |
Optional common parameter. This parameter accepts the values true or false (the default is false). If this parameter is set to true then the console output won't contain any colors.
|
logPath |
Optional common parameter. This parameter can either be used to set the name of the folder in which log files will be created logfolder, or to specify a path to single file, which will be used for all logs. Both relative and absolute paths work. Default value for this parameter is logs folder in the main miner folder.
Examples:logPath=logfolder logPath=logs/log.txt logPath=/var/log/nanominer/log.txt logPath=C:\logs\log.txt |
Automatic Restart Function
With default settings, nanominer will automatically restart if it encounters critical errors in the GPU or lag. (These errors usually arise due to hardware problems or overclocking the GPU.) The automatic restart function can be deactivated using the watchdog parameter.
Likewise, the minHashrate (minimum hashrate) parameter allows the user to set the value of the minimum hashrate which, if exceeded, will cause the miner to restart. This function uses the average hashrate over the last ten minutes, as displayed in blue in the console log. If the average hashrate over 10 minutes is lower than the set value, the miner will restart. With default settings the minimum hashrate is not set.
Another function on nanominer that improves the miner's automatic functioning is handled by the restarts parameter.It sets the number of times the miner restarts before rebooting the worker (rig). By default the miner will only restart itself.
minHashrate |
Optional algorithm parameter. This is the minimum acceptable hashrate. This function keeps track of the rig's total hashrate and compares it with this parameter. If five minutes after the miner is launched the set minimum is not reached, nanominer will automatically restart. Likewise, the miner will restart if for any reason the average hashrate over a ten-minute period falls below the set value. This value can be set with an optional modifier letter that represents a thousand for kilohash or a million for megahash per second. For example, setting the value to 100 megahashes per second can be written as 100M, 100.0M, 100m, 100000k, 100000K or 100000000. If this parameter is not defined, the miner will not restart (with the exception of the situations described in the watchdog section).
|
maxRejectedShares |
Optional paramter. Can be used to set the maximum amount of rejected shares before restarting miner process/rebooting the rig. Restarts caused by this option count towards the restarts parameter. Option is disabled by default.
|
restarts |
Optional common parameter. This parameter sets the number of times the miner will restart before rebooting the rig. In case of GPU problems like hardware errors or lag, or in case of hashrate degradation (if the minhashrate option is used), nanominer will restart. However, certain errors cannot be fixed by restarting the program. In such cases it is necessary to reboot the rig.
|
watchdog |
Optional common parameter. This parameter manages the miner's restart function when running into critical GPU errors or lag. It accepts the values true or false. By default, true – automatic restart - is activated. |
To reboot, the miner loads the reboot.bat script from the current directory if running on Windows or reboot.sh if on Linux:
reboot
The reboot.sh file on Linux must be given execute permissions in order for it to work. The typical content of the reboot.bat script for Windows:
shutdown /r /t 5 /f
The script must be written by the user. To run reboot script instead of restarting miner every time a critical error occurs, just set
restarts=0
Auto-update options
checkForUpdates |
Optional common parameter. This parameter accepts the values true or false (the default is true). If this parameter is set to false then nanominer stops checking for the newest release version on every startup. |
autoUpdate |
Optional common parameter. This parameter accepts the values true or false (the default is false). If this parameter is set to true and checking for updates is enabled, then nanominer will update itself on every startup, provided there is a newer version available. |
Pool options
sortPools |
Optional algorithm parameter. This parameter accepts the values true or false (the default is false). If this parameter is set to true then the best pool will be chosen by least ping (not by the pool list). |
sendHashrate |
Optional algorithm parameter for Ethash and Ubqhash algorithms. This parameter accepts the values true or false. The default value is true (if JSON-RPC pool protocol is used). |
farmRecheck |
Optional algorithm parameter. The interval (in milliseconds) between polling the node for new jobs in solo mining mode for QuarkChain. Default value is 200. |
shardId |
Optional algorithm parameter. Can be used to set a shard ID for QuarkChain solo mining. Only shards using Ethash algorithm are supported. This parameter should be specified in hex, e.g. 0x1, 0x10001, 0x10002, etc. For more information on shards, visit this and this link. Default shard ID is 0x1. |
Epoch tools
epoch |
Optional algorithm parameter. Ethash algorithm specific option to check miner behaviour on different Ethash epochs. |
zilEpoch |
Optional parameter. Sets the epoch of Zilliqa DAG to store in GPU memory (default is 1). |
Other paremeters
protocol |
Optional parameter. Can be used to set the pool protocol to stratum. If not specified, nanominer will try to detect the pool protocol automatically. |
rigPassword |
Optional parameter. The password for the rig (or worker). It may be necessary when working with pools that require registration and setting a rig password. |
devices |
Optional paramter. These are the graphics cards that will be used by the miner. If you do not want to launch the miner on all available GPUs but only on some of them, their numbers can be provided in the devices parameter separated by a comma or space. nanominer numbers the GPUs starting from zero in ascending order of their PCI addresses. You can see a list of available GPUs and the order in which they're in by launching nanominer with the -d command line option:
For example, if there are four GPUs in the system (0, 1, 2, 3) and all but the second-to-last one (indexed as 2) must be set to mine, then the devices option must be set in the following manner: devices=0,1,3
The order of devices determines the order of displayed hashrate. For example, if it is set as devices=3,1,0
then the hashrate line will first display GPU3, then GPU1 and finally GPU0. |
coreClocks, memClocks |
Optional parameters. Can be used to overclock/underclock NVIDIA GPU's. Absolute (e.g. 4200) as well as relative (e.g. +200, -150) values in MHz are accepted. Parameter values must be separated by a comma or space (first value is for GPU0, second is for GPU1, and so on). For example, if it is set as coreClocks=+200,-150
memClocks=+300,3900
then GPU0 will be overclocked by 200 MHz of core and 300 MHz of memory, whereas GPU1 core clock will be underclocked by 150 MHz, and its memory clock set to 3900 MHz. You can also apply same settings for each GPU by defining only one core and memory clock value, for example: coreClocks=+200
memClocks=+300
|
powerLimits |
Optional parameter. Can be used to set Nvidia cards power limits from -50 to 50. For example, -20 means 80% power limit, 10 means 110% power limit. Parameter values must be separated by a comma or space (first value is for GPU0, second is for GPU1, and so on). You can also apply same settings for each GPU by defining only one power limit value. |
memTweak |
Optional parameter. Can be set to modify AMD GPU timings on the fly for Ethash/Etchash/Ubqhash algorithms. The following AMD ASICs are currently supported: gfx900, gfx901, gfx906, gfx907, Baffin, Ellesmere, gfx804, Hawaii, Tahiti, Pitcairn, Tonga. Miner must be launched using admin/root privileges in order to change timings. Default memory tweak value is 1 which means slightly improving memory timings. Zero value means timings are left as is without modifications. Parameter values must be separated by a comma or space (first value is for GPU0, second is for GPU1, and so on). Supported memory tweak value range is from 0 to 10 (0 means disabling timings modification, 1 is the least intense, 10 is the most intense), for example: memTweak=9,8,10
It is recommended to begin from lower values and increase them if the miner works stably. You can also apply same settings for each GPU by defining only one memory tweak value: memTweak=10
|
fanSpeed |
Optional parameter. Used to set the GPU fan speed to a specific percentage from 30% to 100%. If below 30, automatically sets to 30. If the value is incorrect, i.e. negative or non-numeric value, sets to the last used value. |
cpuThreads |
Optional parameter for CPU mining. Specifies the number of concurrent CPU threads to use for mining. All threads are used by default. |
dagSer |
Optional parameter for Ethash, Etchash, FiroPow and KawPow algorithms. This parameter accepts the values true or false (the default is false). If this parameter is set to true then the DAG will be generated sequentially on each GPU. Otherwise all the GPUs generate DAG at the same time. |
lhr |
Optional parameter for Ethash and Etchash algorithms. Can be used to set desired percentage of full unlocked hashrate. Valid range is from 50 to 100. Also can be set to off (-1) or auto (0). Use off for non-LHR cards and auto for automatic LHR card detection and tuning. Default is auto. This parameter can be set for each GPU separately. In this case, order must correspond to the order of GPUs, specified in devices parameter. For example: devices=0,2,3
lhr=71.5,off,0
means 71.5% for GPU0, off for GPU2 and auto for GPU3. |
silence |
Optional parameter. This parameter accepts the values from 0 to 3. Control the amount of information displayed in the logs and on the screen. 0: All the information is logged. Default behaviour. 1: Hide frequent job messages. 2: Also hide shares messages. 3: Also hide hashrate prints. |
webPassword |
Optional parameter. Password for web interface. There is no password by default (web interface is read-only). |
webPort |
Optional parameter. Port for web interface. The default port is 9090. Zero value disables web interface. |
mport |
Optional parameter. This is the network port for remote monitoring and program management through EthMan or other programs that use a similar API protocol format. The program supports all API functions, including restarting the miner and rig(s). You can block miner management through API (in which case the miner will only display the statistics and won't respond to any commands). To enable this function, a "minus" (-) sign must be written before the port number. And you can completely deactivate remote monitoring. To do this, the port number must be set to "0" (zero). Default value: -3333 (This means that the miner blocks management through API and displays statistics on port 3333). |
useSSL |
Optional parameter. This parameter accepts the values true or false (the default is true). If this parameter is set to true then miner always tries to use SSL pool connection first and fallbacks to unencrypted connection if SSL connection failed. If this parameter is set to false then miner doesn't try using SSL for pool connection. |
countDevShares |
Optional parameter. This parameter accepts the values true or false (the default is false for QuarkChain solo mining and true for other coins). If this parameter is set to true then shares accepted or rejected by pool during fee time will be included in miner statistics. Otherwise only shares during user mining are included to miner statistics. |
validateShares |
Optional parameter. This parameter accepts the values true or false (the default is false). If this parameter is set to true then shares of ethash algorithms family on AMD GPUs are validated by CPU. Also in this case share difficulty is shown for AMD GPUs. |
sendHashrate |
Optional parameter for Ethash, Etchash and Ubqhash algorithms. This parameter accepts the values true or false. The default value is true (if JSON-RPC pool protocol is used). |