API Docs


The configuration file

On luxminer, configuration is done via the luxminer.toml file. As the name suggest, this is a TOML (opens in a new tab) formatted file that stores all of the main miner options. By default, luxminer looks to the executable folder it is in to find the configuration file. On the provided image it means that the configuration file is found at /luxminer.toml.

Configuration can be changed either via UI, which is applied and saved (if autosave is enabled) immediately, or manually on the TOML file, but this will required an application restart. It is also possible to temporarily use a different configuration file, by calling luxminer with the -c <FILENAME> flag. Just be mindful that the init script does not use this flag; it picks up the configuration file in the default location.


Autosave is your friend

The default enables the autosave feature. This means that you have an "automatic backup" of your configuration changes, and can manually override your current TOML file with a previous, working version.

The previous versions of your config file can be seen at /backup.

Creating a configuration from scratch

If, for some reason, you want to start your configuration from scratch, it is very easy to generate a new, blank configuration template:

# go to the root directory
$ cd /

# create a new config file
./luxminer --init

This will create a new luxminer.toml file unless it already exists. You can change the name and location of the file using the -c flag, like explained in the previous section.

The generated file will be created with commented sections explaining each available option and its defaults. Note that if you start luxminer without aconfiguration file, a new one will be created for you, with the default values.

The next sections will explain the finer details of each section of the configuration file.