Welcome to the PiMP OS and Miner.farm forum.

Tutorial: How to use the Miner.farm Web Application


  • Staff

    Menu Navigation

    You have to login to see the menus. If you are logged out, you will see "Log In" on the top right corner and the left menu navigation will not be visible.

    Menu Bar (Top)

    TopMenu.png

    - Light Mode / Dark Mode:

    Allows you to toggle between light/dark view mode.

    Light Dark
    Main.png MLAB Main.png
    - My Farms:

    You will have a list here of farms that you can quickly jump to:

    41e2da90-4062-4e67-b7b5-c8ef301a648a-image.png

    • Owned: These are farms that are owned by this account.

    • Managed: These are farms who have used the Farm Admin page to designate you with either the Access or Manage role. Access means you can view their farm. Manage means you can make changes to their farm (start/stop miners, etc.)

    • Starred: If you are logged in, when you view another miners farm, you will see a star icon to the right of the farm name. If you click this, it is like clicking a Favorite or Bookmark in your browser. It will add their farm to your Starred list so that you can view it later. This can be used to view your friends farms or farms that you like.

    - Account Menu:

    When logged in, this will be your login email address on file.

    AccountMenu.PNG

    • Your Account: Goes to your account management screen. Account Page allows you to update billing/shipping address; change pw; download pimp os links; manage pimp os keys (clear count, transfer key to someone else); renew subscriptions (add more rigs or months to a subscription); view/create farms; view transaction history / account log. For managing your account, We have posted a detailed guide here: https://forum.getpimp.org/topic/51/tutorial-how-to-manage-your-miner-farm-account

    Side Menu Bar (Left)

    05d98b3a-8a05-4b71-869f-7275fb56f126-image.png

    This is the main navigation menu.


    Farm View

    Main.png

    Farm View is the primary view of your farm. If your farm is Public, then this view (and only this view) are viewable by others, unless you have designated someone as Access or Manage roles on the Farm Admin page.

    There is a Summary section at the top, and an Agents section. In the collapsed mode, you can click agents to expand that agent and show its miners. Clicking a miner will "drill down" into the Miner View for more detailed information about that miner's devices (hashrates, temps, clocks, etc.)

    - Farm View: Summary Section

    FarmView - Overview.PNG
    In the Summary Section you will see the name of your farm, total farm hashrate and power use, and the number of Agents, Miners, and Devices in the farm. The Summary Graph shows total hashrate per agent. You can click specific agents to focus the graph on them, and you can click and drag on the graph to zoom in for more detailed information.

    - Farm View: Agents Section

    In the Agents Section, each agent that connects or has connected to your farm and has miners added is listed. (If you do not have any miners added, they will still appear on the Farm Admin page with no miners. You could also go to the agent or rig and add a miner and it will then show up in the Farm View.)

    265f0fd5-b691-4a40-bf88-4a4fea0464d3-image.png

    - Farm View: Default / Collapsed views:

    Default Collapsed
    FarmView - Normal.PNG FarmView - Collapsed.PNG

    In the Default or Collapsed views, each Agent is shown as: Agent Name; Agent hashrate; # miner count (instances); total power usage for the agent (sum of all running miners' baselines + gpus); PiMP version (if this Agent is running PiMP OS) and the Agent uptime (Time that the minerfarm service has been running on the rig.)

    The Agents are colored based on Status:

    Color Example
    Green Green.PNG
    Yellow Yellow.PNG
    Red Red.PNG
    • Green means mining and within Alert Profile parameters.
    • Yellow means one or more miners is outside of the Alert Profile parameters or not running.
    • Red means Agent down.

    Inside each Agent, you see a row for each mining instance running on the rig. For example if you use pimp --start 1 or minerfarm --start 1 Then this will be the first miner listed on the agent.

    Each mining instance is shown as Agent Name (dot) ID number, example: m171-6x1070.1 is the miner with ID 1 on the m171-6x1070 agent (rig). Then that particular mining instance's Hashrate, Devices, Active Pool, Miner software and version, and the uptime of the mining instance itself is shown for each mining instance.

    If you click the Mining Instance row it will take you to the Miner View for that instance with even more detailed information. This is where you can control the miner (start/stop, add) See "Miner View" below for details.

    - Farm View: Compact View

    This view allows you to shrink the details about your farm into a spreadsheet-like view. This also helps users who were familiar with ethOS panel or have larger farms see problems at a glance. Each line item is one miner instance. So a rig or agent with several miners added to it will show them all here as separate miner instances.

    92491822-7f6e-4b65-b0e2-97a96a7c8b61-image.png

    In the chart, the abbreviated columns can be hovered over to see a tooltip hint. But here are the columns:

    • V: OS version
    • M: Miner software/version
    • D: # devices
    • name: This is the miner name: agent name dot miner ID
    • a: Alerts (big red X if there are alerts for this miner)
    • loc: Local IP address on the farm
    • p: Ping from miner.farm to this agent
    • b: Time since last boot (uptime of the agent host)
    • m: Miner uptime (uptime of the running miner instance)
    • L: Load average (% of the available CPU cores in use by running - processes/applications/miners)
    • C: CPU Temp in degrees C (on the agent host)
    • R: Available system memory in GB (on the agent host)
    • F: Free disk space (on the agent host)
    • H: total hashrate of this miner
    • hashes: individual per-device hashrates reported by this miner
    • temps: individual per-device temperatures in degrees C reported by this miner
    • fans: individual per-device fan speeds in % reported by this miner
    • core: individual per-device core clocks reported by this miner
    • mem: individual per-device memory clocks reported by this miner
    • power: individual per-device power usage in watts reported by this miner

    Clicking on any miner goes into the Miner View for that miner.


    Miner View

    Miner.png

    Miner View shows everything about a running miner instance.

    - Miner View: Overview

    MinerView - Overview.PNG

    Stats on the left are for this miner instance, and also includes a very important metric: Accepts/m or accepts per minute. This and hashrate per watt are considered by many miners to be the key to mining profits. The miner is also shown on this view.

    The graph on Miner.farm shows Hashrate / Accepts as well as an all new Pools bar graph that shows usage of pools by this miner. More details about Pools are available on the Pool view, but this allows you to see where your mining resources are sending hashes. There are also new count panels that show Reject Rate %, HW (Hardware) errors (as reported by the mining instance) and Found Blocks.

    Note on HW Errors: ETH and ASIC can be known to report high HW errors - this is normal.

    Note on Found Blocks: Many miners do not report Found Blocks. Mostly you want accepted shares when you are pool mining. If your share contributes to a Found Block for the pool and that pool reports to the miner and the miner reports a block was found, then it will be counted here.

    - Miner View: Devices Section

    MinerView - Devices.PNG

    Below the Miner View Overview, on the left side is a devices panel which shows a heading with the current pool, algorithm, and Reject Rate %. Under this heading there is a list of devices that are being used by this miner (mining instance.)

    The Devices are colored based on Status:

    • Green means mining and within Alert Profile parameters.
    • Yellow means this device is outside of the Alert Profile parameters.
    • Red means device is stopped or dead

    The following fields are shown on Miner View Devices Section:

    • GPU: listed by PCI Bus ID
    • Status: Alive means hashing or idle. Sick means has had a problem, restart needed. Dead means likely system reboot is needed.
    • Hashrate of the device
    • Accept/Reject: count of each, and then a % Accepted calculation.
    • HW: Hardware errors reported by the miner.
    • Temp: device temp reported in degrees C.
    • Fan: Fan speed in %
    • I: Intensity set in the FLAGS or configuration file (pcfg/conf) for the miner
    • Core: Core clock of the device
    • Memory: Memory clock of the device
    • Power: Power usage in Watts reported by the device

    API Notes: Depending on API skill set of the miner author as well as the hardware used, we may not get all values.
    Some miners (claymore) misuse system libraries and prevent us from being able to read some values.

    - Miner View: Miner Control Section

    8e8acbbd-2d40-473e-97d7-ee23dd40261e-image.png

    There are various controls and inputs shown here related to this mining instance:

    Start/Restart/Stop: If the miner is not running, you have a Start button, otherwise you have Restart and Stop buttons along with the miner's Runtime (uptime of this instance.)

    Miner config: Displays the currently chosen profile that this miner is using. This consists of binary and config file used for this miner. You can then edit the corresponding config file using the Config Editor in Farm Admin (Pro and above subscriptions) or on the rig.

    Alert Profile: This is where you can choose the Alert Profile you designed in Alert View and assign it to this miner, so that it alerts you based on criteria you specify (low hashrate, high temp, etc.)

    Baseline Miner Power Usage: Here you set a constant fixed value added to total miner power usage reporting. Basically, you would put the power usage in watts of your motherboard, cpu, and ssd here, to be added to the GPU wattages so you have a realistic view of your hashrates per watt overall on the farm.

    Note: There is also a Host Baseline Power Usage option that you can set Per Agent, that will apply to all miners on a rig. This one is in Farm Admin > Agent Preferences > Set the baseline power usage (cpu/mb/ram/ssd/psu) for this agents host.


    Pool View

    Pools.png

    Pool View allows you to view your farm per pool connection instead of per agent. This allows you to see where your hashes are going at a glance so it can help you make your profit calculations, double check your payouts, etc. You can also set the Pool's Reject Rate % and assign an alert if it is reached. The layout has a Summary Section similar to the other Views, followed by the Pools Section and a Settings Section.

    - Pool View: Summary Section

    PoolView - Overview.PNG

    In the Pool View, the Summary Section simply shows the total farm hashrate, number of pools and active miners, and the graph is a bar graph per-pool.

    - Pool View: Pools Section

    PoolView - Pools.PNG

    In the Pools Section, each pool that is defined by the current confs or has been used on this farm before is shown in the list, and has a little sub-section. The heading contains the following information:

    • URL: The pool address and port.
    • Miners: Number of miners hashing to this pool.
    • Hashrate: Total hashrate going to this pool from this farm.
    • Reject rate: % Shares rejected by this pool from this farm.
    • Pool Settings button: Allows you to set a Reject rate % threshold, Alert if average pool reject rate is higher than this. Miners reaching this threshold will show an alert in the Farm View and/or Alert View. You can also turn on Email alerts for this and specify an email address to receive the alerts.

    In each Pool sub-section, it will list each mining instance that is mining to that pool, with the following fields:

    • Miner ID: Agent name (dot) Miner ID
    • User: Username, either the pool login username dot worker, or wallet address of the coin you are mining (varies by pool)
    • Devices: how many devices are mining on that instance to that pool
    • Hashrate: how much hashrate that mining instance is sending to that pool
    • Rej: % shares rejected by the pool for that mining instance
    • Runtime: time this mining instance has been running.

    Pools are sorted Newest at the Top but grouped in the following order: Pools with miners assigned that have problems, then current active (Blue) pools, then inactive or old pools that no longer have miners assigned to them.

    The Pool sub-sections are colored based on Status:

    • Blue means all mining instances assigned to this pool are mining and within Alert Profile parameters. All mining instances inside the pool section show green.
    • Yellow means this Pool has mining instance(s) outside of the Alert Profile parameters.
    • Gray means there are 1 or more stopped miners, or no miners at all, assigned to this pool.

    Each mining instance shown in a pool, if it is mining, will show the total stats for that mining instance. You can click one of the miner instances to go to the Miner View for it whether it is stopped or mining.


    Alert View

    Alerting.png

    Alert View is available on all subscription levels, even free. However, having multiple Alert Profiles, and getting Alert E-mails, those features require Farmer and higher subscriptions.

    Alert View allows you to make profiles of min/max threshold values. When your miners go outside of these values that you set, the miner will show an Alert on the Farm View and/or Miner View (and change color); it will show in the Alert History on Alert View.

    Note: If you have Farmer and above, you can get e-mail when these events occur.

    - Alert View: Summary Section

    AlertView - Overview.PNG

    The Summary Section on the Alert View shows a count of problems, active miners and active devices, and a Alerts Graph of Problems. This is just a "count" of problems and you can click on the miners names on the right and/or drag the graph to zoom in to get more information.

    for the addition of the "Add profile" type selection and button. To add a profile, pick a type and click Add Profile.

    - Alert View: Alert Profiles Section

    AlertView - Profiles.PNG

    In the Alert Profiles Section, each profile created is shown in the list, and has a little sub-section.

    In the Alert Profile heading, there is information about this Alert Profile:

    • Profile Name: Default for the default profile. This is a special profile that is assigned to all new miners added to the farm. It cannot be deleted.
    • Total In Profile: Number of miners assigned to this profile. You can assign a different Alert Profile to a Miner in the Miner View.
    • Miner Alerts: You can choose if it will alert you if the miner completely stops.
    • Email Alerts: If you have Farmer and above subscription level, you can get e-mail when these events occur.
    • Per Device Limits: Shows the thresholds for alerting for this profile.
    • Profile Settings Button: Clicking this button will bring up a new window with the available options for this Profile:

    You can set the various minimum and maximum thresholds for when the miner will alert you.
    Set a value to 0 to disable it.
    You can set the recipient e-mail address for this profile, and turn e-mail alerts on and off.
    You can rename the profile. (Including the default)
    You can delete the profile. (Except for the first profile which is the Default)

    In each Alert Profile sub-section, it will have a line item for each miner instance that is assigned to it, with the following fields: Miner ID, Devices, Hashrate, Miner version, and Total Runtime of the miner instance. If you click a miner it will take you to the Miner View for that miner.

    - Alert View: Settings Section

    AlertView - Settings.PNG

    In this small section you can choose one of the existing Alert Profile Templates we provide and Add a New Profile. Then you can modify and assign that profile using the settings mentioned above.

    - Alert View: Alert History Section

    AlertView - History.PNG

    The Alert History Section is a running log of problems with this farm. There are 3 columns: Unit (miner ID reporting), Problem (description of the Problem), and either time the Problem started or ended, depending on if the problem is still occurring. Current Problems are listed first, followed by Cleared Problems (Cleared Alerts). This way you can see right away what problems require attention, and then have a look upon the issues that have happened recently.


    Farm Admin

    Farm Admin page is where you control Farm-wide settings. Available settings and options here are depending upon the subscription level that you have.

    - Farm Admin: Overview Section

    In the Farm Admin Overview, it will show the current Miner.farm Subscription Plan, the Maximum number of miners that can be managed with this plan, and the expiration date/time and days remaining on the subscription.

    8ae3c3ef-dac2-48bc-90c5-e52be9be18f2-image.png

    - Farm Admin: Agents Section

    The Farm Admin Agents Section lists all of the agents that are reporting to this farm. Agents are connected to this farm by entering this farm's API keys into the minerfarm agent on a mining rig.

    The Group Control button allows you to take an action against more than one rig at the same time. Clicking this button will reveal the Agent Group Control window:

    The name and system info (hostname, LAN IP address, and system uptime) will be shown for each agent along with a tickbox (checkbox) to the right side of the line. You can check boxes for agents you want to take an action on, and then choose from the following actions:

    Add Miner to Agents: You can choose from the dropdown box of available miner profiles, and then click Add to Agents. This will add that profile to all selected agents.

    Update Agents: This will update pimp software on the specified agents.

    Restart Agent Service: This will restart the minerfarm agent service on the specified agents. Equivalent to going to each rig and doing minerfarm then 'x' then 'o' or issuing the command systemctl restart minerfarm

    Reboot Agent Host: This will reboot the specified agent machines.

    - Farm Admin: Miner Configs Section (Pro and above)

    This is where you can manage your rigs mining configuration files, aka the profiles, aka the pcfg/conf files in /opt/confs. It will list all of the config files in your "miner.farm library" and will have two buttons at the top:

    • New: Create a new text file, and allow you to edit it and specify a filename and save.
    • Files Manager: launch the file manager feature of Farm Admin.

    22138995-b1f0-4824-bfb0-a4c398a76fc3-image.png

    Files Manager is a tool that lets you manage the library of config files stored on your miner.farm account and push/pull them to and from your rigs. The idea is that you can grab the defaults, customize them, then deploy them to your rigs quickly and easily. You can also take customized or tested configs from your rigs, edit them and push them back or to other rigs.

    There is a list of Agents, followed by action buttons.The name and system info (hostname, LAN IP address, and system uptime) will be shown for each agent along with a tickbox (checkbox) to the right side of the line. You can check boxes for agents you want to take an action on, and then choose from the following actions:

    2ee2c2f2-fd6b-4929-92e1-bcb13aef209b-image.png

    • Send a custom config to the selected Agent hosts / Send: You can send customized config files (if any exist in your library) to the specified agent hosts.
    • Restore a default config to the selected Agent hosts / Restore: You can reset a default file on the agent host to undo changes that were made to it. (Restore a known-good tested profile.)
    • Get all custom config files from selected Agent hosts / Pull: This will poll the specified agent hosts and grab all of the files that you have changed, and place them in your miner.farm account library.
    • Get all default PiMP config files / Get Defaults: This will place all of the current default config files into your miner.farm account library, so you can begin customizing them and then push them to the rigs.

    Once you have files in your library, there will be a line item for each file with the filename, source, and updated time UTC. Sources include: Default (provided by PiMP), User (modified by you), or the name of the agent that you pulled the config from.

    - Farm Admin: Users Section

    If you have a Pro or higher subscription, you are able to assign users roles so they can have access to your farm. Click the New button, access type, and their Miner.farm account email and they will see your farm in their "My Farms -> Managed" top dropdown menu. Clicking an existing user in the list will allow you to change/remove their access.

    • Users with "Access" can view your farm when it is Private.
    • Users with "Manage" have FULL ACCESS to Miner and Farm controls.

    b91c3426-b1a7-410a-902e-e809250b64d7-image.png

    - Farm Admin: Farm Preferences Section (Miner and above)

    If you have Miner or higher subscriptions, you will be able to use some of these options to customize your farm settings:

    • Farm Name: name your farm. (Miner and above)
    • Farm Privacy: set your Farm View to private. (Note: Other pages are always private to you and you must be logged in for those pages or have a Pro account and assign people Access or Manage role to see them.) (Farmer and above)
    • Farm View Style: You can choose Collapsed or Compact view to easily manage and view your farm as it grows. (Farmer and above)
    • Host Baseline Power Usage: There is a Host Baseline Power Usage option that you can set Per Agent, that will apply to all miners on a rig. This one is in Farm Admin > Agent Preferences > Set the baseline power usage (cpu/mb/ram/ssd/psu) for this agents host.

    Note: You can also set this value per-miner individually on the Miner View page.

    11b12691-f1d5-4c51-b62f-b63b370e7fcf-image.png

    - Farm Admin: Farm Keys Section

    These are your API keys to access miner.farm! These keys are used to identify your minerfarm agent to the server. You enter them into the agent using the instructions there and the agent will start reporting to this farm. If you have multiple farms, or generate new keys, you will notice the short key does not change - this is per-user. The long key is per-farm. These keys will also be used to access the Miner.farm REST API.

    - Farm Admin: Footer Section

    Not used often, but you can transfer this whole farm to another user account, or delete the farm. Most likely, you would want to coordinate with the PiMP Support team if you are making changes of this size, so they can ensure you have a seamless transition.



  • Can you explain the custom views feature available at Farmer level and above?


  • Staff

    The 'Custom Views' feature controls how your Farm View appears. The examples here show the 'collapsed view', which is available with Farmer level and above. The default view shows each agent uncollapsed in the Farm View.


 



Want 10% more hash from your rigs?



We promise to keep your email safe and never spam you.



Copyright (c) 2012-2018 PiMP LLC. All rights Reserved.