Hash Auger features a mobile friendly web dashboard that is available when the Web API is enabled. This dashboard displays information about current device status, wallet balances and earnings information. Depending on the API settings, the dashboard can also be used to send some remote commands to your mining rig.

The Hash Auger web service is hosted on each user's mining rig to give users complete control over their data. Users who wish to access the web dashboard or the API from another computer will most likely need to configure their firewall and router settings to permit this access. Refer to the Configuring the API wiki page for details.

HA_DB.png

Accessing the Dashboard

The Hash Auger mining dashboard is available by accessing the /dashboard url when the API web service is enabled. For example, to access the dashboard in a web browser running locally, either http://localhost:<port number>/dashboard or http://127.0.0.1:<port number>/dashboard can be used where <port number> is the number of the port assigned to the web API in the Hash Auger settings. Similarly, the dashboard may be accessed from another machine (if the firewall is configured to allow this) using http://<rig ip>:<port number>/dashboard. Finally, through the use of port forwarding on a router, the dashboard page can be accessed from outside the personal network by using: http://<router ip>:<port number>/dashboard.

Authorizing API Keys

Hash Auger supports two API keys to limit access to those users who provide a key. An authorization page is displayed if a user attempts to access the dashboard if either the Readonly key or the Full Access key are defined in the software's API settings. Once the user has provided a valid key, they will be able to access the dashboard in either readonly or remote management mode based on the key they provided. The following scenarios describe how the web dashboard can be accessed based on the use of API keys:

  • Neither the Readonly nor the Full Access key are defined in the settings: the dashboard will be displayed without the need to authorize access first.
  • Both the Readonly and Full Access keys are set: the user must provide either one of these two keys in order to access the dashboard. The dashboard's mode will depend on the key that was provided.
  • The Readonly key is not set in the settings, but the Full Access key has been defined: the user can either enter the Full Access key into the dashboard's authorization page or they can leave the key field empty and check the Read Only Mode checkbox to show the dashboard in read only mode.
HA_DB_Auth.png

Executing Remote Commands

Hash Auger's web API includes some configuration options to prevent the accidental execution of remote commands. First, the Execute Commands? API setting has to be enabled in order to run any of these commands. Optionally, a Full Access API key can be set in the API settings to limit the execution of commands to only those that provide this key; any remote commands that do not include this key will be ignored. The web dashboard uses these settings and will display in a readonly mode if remote commands are disabled or the user has not provided a Full Access Key.