wth_config_example.yml

---
##===========================================================================================
## Config file is in YAML format, which is far easier to use than JSON, but you
## have to keep the integrity of the indentation for nested attributes.
##
## Uncomment any directive below by removing the single "#".  Anything with "##" is actually
## only a comment and not a config option.
##===========================================================================================
##
## Version should not be change by hand.  It is a experimental feature to help keep
## your config file updated with new options as they are added.
version: 20211103
##===========================================================================================
## General settings
##===========================================================================================
## Console_out if true or false for console UI and data display
console_out: true
## Start the web server, true or false.  More web server settings under "web_server"
web_server_start: true
## Frequency to use for checking nodes when not specified in module
default_module_frequency: 8
## You can name any of the 10 pages with your own title below.
# pages:
#    1: Overview
#    2: Pools
#    ...
#    10: System Info
##===========================================================================================
## Web server settings
##===========================================================================================
web_server:
## Auto generate html output from console output.  Works even when console_out=false
  html_out: true
  port: 8080
## Host sets interface for web server.
## Examples: 127.0.0.1, localhost, 192.168.0.10, 0.0.0.0 (all interfaces).
## Default is 127.0.0.1, meaning only accessible on the local machine
  host: 127.0.0.1
## Enabled SSL using self signed cert.  This may cause browsers to complain and require an
## exception or approval
  ssl: false
## Change api to true if you want to access JSON formatted collected data in WTH
## Url: http://127.0.0.1:8080/api?module=<module_name>
## To show module names:
##      http://127.0.0.1:8080/api?module=list
  api: false
## Uncomment to require a unique key to access web interface.
## Examples: http://127.0.0.1:8080?key=<my_unique_key>
##           http://127.0.0.1:8080/api?module=list&key=<my_unique_key>
#  key: <your_unique_key_here_with_no_spaces_or_special_characters>
#
##===========================================================================================
## Modules && Settings
##===========================================================================================
modules:
##
## Examples of modules are below.  The presence of a module config entry enables that
## plugin, which will be autoloaded on demand (specified in the "api:" option).
## The key is YOUR NAME for the module, allowing you to use the same API module for different
## checks & output panels, requiring only different keys.
##
## Common options, format, and descriptions / notes.
##
## Modules provide specific end point functionality to display.  You can have multiple
## instances of a module by using different "your_unique_key_here", which should have no
## spaces or special characters, but otherwise is whatever you wish to call it. Please note,
## this name (or key) is used to retrieve data via WTH's own API, so if you plan to use it,
## you might want to not go crazy.
##
## your_unique_key_here:
##   api: <api_name> - REQUIRED! - This actually identifies the module to load for this entry.
##   dump: true/false - OPTIONAL: Enables logged output of requested data into tmp folder
##   extra: <your_mini_note> - Optional: Small note for on display title
##   coin: <coin_symbol> - REQUIRED! - Used in display and price predictions.  Where
##         specified in the config, required, but consider it required for all miners
##   every: <integer> - OPTIONAL: number of seconds between checks.  Some modules enforce
##          minimums, so be aware of that.
##   page: <integer> - OPTIONAL: Integer, what page number to display on (1-10).  Default = 1
##   port: <integer> - DEPENDS: Target service port number as integer, if required by module.  
##         In some cases, mod developer may have added common port as default for that miner.
##   columns: <comma list of column #s> - OPTIONAL: Show only columns designated, starting with
##            second column (numbered 1).  Example: 1,2,5,8.  Some modules may not respect this
##            option or ignore it for mandatory columns, like gpu data.
##   nodes: Key/Value address pairs for module.  Could be name/ip or wallet_waddress/URL as
##          examples.
##     <name1>: <ip_address1>[:port#][:module_required_options per host]
##     <name2>: <ip_address2>
##     <name3>: <ip_address3>
##   <module_settings1>: example of a module with unique setting. See module documentation
##   <module_settings2>: example of a module with key/value unique setting.
##      <key1>: <value1>
##      <key2>: <value2>
##
## GPU module options:
##   gpu_rows: <Integer> - OPTIONAL, defaults to 5, specifies GPUS to show per row
##   standalone: <true/false> - OPTIONAL - Display in narrow format for small screens.
##
## Unique optional modules settings will be provided for each module in the docs directory.
##
##===========================================================================================
##
##-------------------------------------------------------------------------------------------
## Claymore GPU Miner (and EThman/Ethermine API compatible miners)
##-------------------------------------------------------------------------------------------
#  claymore_example:
#    api: claymore
#    port: 3333
#    coin: ETH
#    nodes:
#      <my_node1>: <ip_address1>:[optional port or leave empty]
#      <my_node2>: <ip_address2>:[optional port or leave empty]
##-------------------------------------------------------------------------------------------
## GMiner GPU Miner
##-------------------------------------------------------------------------------------------
#  gminer_example:
#    api: g_miner
#    port: 10555
#    coin: ETH
#    nodes:
#      <my_node1>: <ip_address1>:[optional port or leave empty]
#      <my_node2>: <ip_address2>:[optional port or leave empty]
##-------------------------------------------------------------------------------------------
##  Lol GPU Miner
##-------------------------------------------------------------------------------------------
#  lol_miner_example:
#    api: lol_miner
#    port: 9095
#    coin: ETH
#    nodes:
#      <my_node1>: <ip_address1>:[optional port or leave empty]
#      <my_node2>: <ip_address2>:[optional port or leave empty]
##-------------------------------------------------------------------------------------------
## Nano GPU Miner
##-------------------------------------------------------------------------------------------
#  nano_miner_example:
#    api: nano_miner
#    port: 9090
#    coin: ETH
#    nodes:
#      <my_node>: <ip_address>:[optional port or leave empty]:<algorithm> (see nano pool docs)
#      <my_node>: <ip_address>:[optional port or leave empty]:<algorithm> (see nano pool docs)
##-------------------------------------------------------------------------------------------
## NBMiner GPU Miner
##-------------------------------------------------------------------------------------------
#  nbminer_example:
#    port: 22333
#    coin: ETH
#    api: nbminer
#    nodes:
#      <my_node1>: <ip_address1>:[optional port or leave empty]
#      <my_node2>: <ip_address2>:[optional port or leave empty]
##-------------------------------------------------------------------------------------------
## Nice Hash Quick Miner
##-------------------------------------------------------------------------------------------
#  nice_hash_qm:
#    api: excavator
#    port: 18000
#    coin: NICEHASH_ETH
#    extra: ETH
#    nodes:
#      <my_node1>: <ip_address1>:[optional port or leave empty]
#      <my_node2>: <ip_address2>:[optional port or leave empty]
##-------------------------------------------------------------------------------------------
## Phoenix GPU Miner
##-------------------------------------------------------------------------------------------
#  phoenix_example:
#    api: phoenix
#    port: 33440
#    coin: ETH
#    nodes:
#      <my_node1>: <ip_address1>:[optional port or leave empty]
#      <my_node2>: <ip_address2>:[optional port or leave empty]
##-------------------------------------------------------------------------------------------
## T-Rex GPU iner
##-------------------------------------------------------------------------------------------
#  t_rex_example1:
#    api: t_rex
#    port: 4067
#    coin: ETH
#    gpu_row: 4
#    nodes:
#      <my_node1>: <ip_address1>:[optional port or leave empty]
##-------------------------------------------------------------------------------------------
## XMRig CPU Miner
##-------------------------------------------------------------------------------------------
#  xmrig_example:
#    api: xmrig
#    port: 8989
#    coin: XMR
#    every: 12
#    nodes:
#      <my_node1>: <ip_address1>:[optional port or leave empty]:[optional coin or leave empty]
#      <my_node2>: <ip_address2>:[optional port or leave empty]:[optional coin or leave empty]
##-------------------------------------------------------------------------------------------
## Cpuminer
##-------------------------------------------------------------------------------------------
#  raptoreum_example:
#    api: cpuminer
#    port: 4048
#    coin: RTM
#    every: 12
#    nodes:
#      <my_node1>: <ip_address1>:[optional port or leave empty]
#      <my_node2>: <ip_address2>:[optional port or leave empty]
##-------------------------------------------------------------------------------------------
## Signum Pool - Miner Information
##
## Capacity is optional and simply provides coloring of calculated capacity versus full capcity.
##
##-------------------------------------------------------------------------------------------
#  signum_pool_miner_example:
#    api: signum_pool_miner
#    api_node: https://europe1.signum.network
#    every: 180
#    page: <#>
#    nodes:
#      <Signum address (not alias)>: <POOL URL>
#      <Signum address 2 (not alias)>: <POOL URL>
#    capacity:
#      <Signum address (not alias)>: <decimal amount of TiB>
#      <Signum address 2 (not alias)>: <decimal amount of TiB>
##-------------------------------------------------------------------------------------------
## Signum Asset Viewer
##-------------------------------------------------------------------------------------------
#  signum_asset_view_example:
#    api: signum_asset_view
#    api_node: https://signawallet.notallmine.net
#    every: 180
#    page: <#>
#    description_length: 60
##   Nodes for asset_view must end with : for silly reasons we won't go into right now. :-)
#    nodes:
#      <Signum address (not alias)>:
#      <Signum address 2 (not alias)>:
##-------------------------------------------------------------------------------------------
## Signum Pool - Pool Information
##-------------------------------------------------------------------------------------------
#  signum_pool_view_example:
#    api: signum_pool_view
#    every: 180
#    record_count: 15
#    show_block_winners: true
#    page: <#>
#    nodes:
#      Signapool NotAllMine: https://signapool.notallmine.net
#    highlight_nodes:
#      <Signum address 1 (not alias)>
#      <Signum address 2 (not alias)>
##-------------------------------------------------------------------------------------------
## Unmineable Pool View
##
##   You wil probably want to set up tor for Unmineable.  See docs for why.
##   You can also just try it and wait until they ban you IP address because
##   they suck.  Then setup Tor and enable tor_socks proxy by it to true.
##-------------------------------------------------------------------------------------------
#  unmineable_example:
#    api: unmineable
#    every: 300
#    page: <#>
#    tor_socks: false
#    keys:
#      KEY: <your_unmineable_key_here>
#      SECRET: <your_unmineable_secret_key_here>
#    nodes:
#      <coin_name1>: <coin_address1>:<coin_symbol>
#      <coin_name2>: <coin_address2>:<coin_symbol>
#      ...
##-------------------------------------------------------------------------------------------
## Flock Pool View
##-------------------------------------------------------------------------------------------
#  flock_pool_example:
#    api: flock_pool
#    every: 300
#    page: <#>
#    coin: RTM
#    nodes:
## Addresses should always be followed by ":" as in the example below
#      <RTM_address>:
#      ...
##-------------------------------------------------------------------------------------------
## Coin Portfolio
##
## See coin gecko for currencies and coin names, examples below, but you can get the
## "name" from their page.  Search the coin and look for "API id" under "Info".  That is
## the coin name.  For supported currencies, see:
## https://api.coingecko.com/api/v3/simple/supported_vs_currencies
##
## profit_round:  Depending on your currency choice, you may want to change this.
## round: Default rounding for a crypto currency, override in the node list if needed.
##
## Please note:  The node data fields are separated by double '::'.  This is due to
## the YAML parser trying to turn number:number:number into some large integer. * shrug *
##-------------------------------------------------------------------------------------------
# portfolio_example:
#   api: coin_gecko
#   page: <#>
#   currency: usd
## Default profit rounding
#   profit_round: 2
## Default rounding
#   round: 6
#   nodes:
#     <coin1_name>: <amount>::<avg_cost>
#     <coin2_name>: <amount>::<avg_cost>::<optional decimal_places>
#     ...
##-------------------------------------------------------------------------------------------
## Zapper.fi Balances module
##
## Networks (specified below) is one of:
##   ethereum, polygon, optimism, xdai, binance-smart-chain,
##   fantom, avalanche, arbitrum, celo, harmony, moonriver
##-------------------------------------------------------------------------------------------
# zapper_fi:
#   api: coin_gecko
#   page: <#>
#    nodes:
#      unique_tag1: <network1>:<address1>
#      unique_tag2: <network2>:<address2>
#      ...
##-------------------------------------------------------------------------------------------
## Libre Hardware Monitor
## (maybe Open Hardware Monitor compatible ???)
##
## See documentation for Libre setup.
##
## User names and passwords should stay in quotes to handle unusual characters.
##-------------------------------------------------------------------------------------------
#  libre_hardware_example:
#    every: 12
#    api: lhm_gpu_w32
#    page: <#>
#    user: "<username>"
#    password: "<password>"
#    nodes:
#      <hostname>: <ip address>
## Advanced example.  To skip an option, leave empty (will look like "::" between options)
## Source is "ohm" or "lhm".  Only "lhm" is tested.
#      <hostname>: <ip address>:<option port>:<optional source>:<optional user>:<optional password>
##-------------------------------------------------------------------------------------------
## Custom Visual Banner / Divider
##
## This banner is inserted on specified page in the order it is defined in the config file.
## If you want it to display between two modules, it has to be inserted into this
## config file between those two modules and have the same page# specified.
##-------------------------------------------------------------------------------------------
#  example_div1:
#    text: Example Text!
#    api: banner
#    page: <page#>
#    align: <center | left | right>
##-------------------------------------------------------------------------------------------
# WTH Link
# Data can be pulled from remote WTH services. More documentation tbd.
##-------------------------------------------------------------------------------------------
#  remote_wth:
#    api: wth_link
#    page: 6
#    remote_module: <remote_api_module>
#    remote_key: <remote_api_key>
#    nodes:
#      <unique_key>: <ip address>::<remote_module_key>
##-------------------------------------------------------------------------------------------
##===========================================================================================
## Plugins
##
## Plugins provide ancillary functionality to the system or to modules, but don't directly
## show data themselves.
##
## Some plugins use lifespan setting to cache data for that many seconds.  This reduces
## your traffic and their API bandwidth/resource consumption.  Recommended values are listed
## below, but some plugins may have hard coded limits you can't go below.
##
## Other config options will be listed with the plugin.
##
## We recommend leaving on the uncommented plugins, as they provide hooks into some of
## the modules to do things like get price conversions of mined/held assets.
##
##===========================================================================================
plugins:
##-------------------------------------------------------------------------------------------
## Whattomine.com
## Plugin for revenue/profit estimations on GPU/CPU using whattomine.com
##-------------------------------------------------------------------------------------------
  what_to_mine:
    lifespan: 300
  coin_gecko:
    lifespan: 180
##===========================================================================================
## THE END
##===========================================================================================