Allmine Portals

Minerator Setup Instructions


  1. Go to the Configurations page and click on Create New Configuration.
  2. On the Name field, enter a display name for this configuration. (This can be anything and is purely for user's reference.)
  3. Fill out all the fields and click on submit. Information about what each field is for are outlined below.
  4. Click on Submit. Upon successful validation it should take you back to the configurations list. Take note of the Configuration Key and proceed to Minerator Setup.

Minerator-related Options

  • Minerator Update Interval - Time in seconds as to how often Minerator will re-request the configuration from the API. Default 3600.

Work Sources

This section is where you enter your pool server information.

  • Algorithm - The algorithm that this specific work source is for.
  • Display Name - A friendly name for this work source. (This can be anything and is purely for user's reference.)
  • Hostname - Hostname to connect to for the pool server.
  • Port - Port number to connect to for the pool server.
  • Username - User or worker name to use for the connection.
  • Password - Password to use for the connection, if applicable.
  • Priority - In the case of multiple work sources for one algorithm, the one with the lower number will be prioritized and the others will be used as failover.

Device Managers

This section is where you put information about your device(s).

  • Display Name - A friendly name for this device manager. (This can be anything and is purely for user's reference.)
  • Device Type - A selection of devices in which bitstreams are available for.
  • Bitstream - A selection of bitstreams applicable for the device that you have selected.
  1. Open a terminal window.
  2. Switch to the root user by typing in sudo su - and entering your password.
  3. Make sure required packages are installed. If the packages are already installed on your system you should see output similar to the one in the image, otherwise it would ask you to confirm by typing Y.

    apt-get install wget gzip screen

  4. Switch to the root user's home directory and download the latest Minerator software from the website.

    cd /root
    curl -JLO https://api.all-mine.co/api/miner/minerator/latestDownload

  5. Extract the archive, rename the file and make it executable.

    gzip -d minerator-version.gz
    chmod +rx minerator-version

  6. Add a scheduled task that will attempt to restart the program automatically if it fails for whatever reason. Make sure to replace insert-config-key-here with the configuration key that you have generated from the Configurations page.

    echo "*/5 * * * * cd /root ; screen -dmS minerator /usr/bin/flock -w 0 /var/run/minerator.lock /root/minerator insert-config-key-here" | crontab


  7. Launch the software inside a virtual terminal (screen). Make sure to replace insert-config-key-here like in the previous step.

    screen -dmS minerator /usr/bin/flock -w 0 /var/run/minerator.lock /root/minerator insert-config-key-here