Configuration

The Foxy-Farmer config (foxy-farmer.yaml) is located in the same directory where you executed the binary.

Example configuration¶

An example configuration can look like this:

backend: gigahorse
enable_harvester: true
enable_og_pooling: false
farmer_reward_address: xch1063ymlv3saaxkh87h287nc3laelnxss0897xdw6g8zj6yvaa4elslg0xfa
harvester_num_threads: 30
listen_host: 127.0.0.1
log_level: INFO
plot_directories:
  - 'D:\plots'
  - 'E:\plots'
plot_refresh_interval_seconds: 900
pool_payout_address: xch1063ymlv3saaxkh87h287nc3laelnxss0897xdw6g8zj6yvaa4elslg0xfa
# environment config options below only for syntax demonstration purposes, apply as need with the values you require
recompute_hosts: [192.168.1.42]
recompute_connect_timeout: 2000
recompute_retry_interval: 100
chiapos_max_cores: 8
chiapos_max_cuda_devices: 1
chiapos_max_opencl_devices: 1
chiapos_max_gpu_devices: 3
chiapos_opencl_platform: 2
chiapos_min_gpu_log_entries: 21
cuda_visible_devices: '0,2'

Configuration Options¶

All environment options for Gigahorse are exposed via the config, so you don't need to fiddle around with setting those anymore.

The config file currently consists of these config options:

Chia options¶

backend¶

Which harvesting backend to use. Possible values: bladebit, gigahorse, drplotter. Defaults to bladebit.

enable_harvester¶

Whether to start a harvester instance as well, or only a farmer instance.

farmer_reward_address¶

The Chia address you want your farmer rewards (0.125 XCH) credited to.

harvester_num_threads:¶

How many threads the harvester service should use to lookup challenges.

listen_host:¶

The host/ip to listen on, will set self_hostname in the chia config of foxy-farmer.

log_level:¶

The log level to use. Possible values: DEBUG, INFO, WARNING, ERROR

plot_directories:¶

The plot directories to use.

plot_refresh_interval_seconds:¶

How often the harvester should rescan for new/deleted plots in your plot_directories.

plot_refresh_batch_size:¶

How many plots the harvester should process at once during plot refresh/rescan. If unset the default value is 300. Decreasing this value will lower the load on your HDDs during plot refresh but increase the time for initially loading them.

plot_refresh_batch_sleep_ms:¶

The number of milliseconds to wait between plot refresh batches. If unset the default value is 1. Increasing this value will lower the load on your HDDs during plot refresh but increase the time for initially loading them.

pool_payout_address:¶

The Chia address you want your pool rewards credited to. This will be used as payout_instructions for all PlotNFTs and if OG pooling is enabled as the payout address for the OG pool.

recursive_plot_scan:¶

Whether to scan the plot directories recursively or not. Will set recursive_plot_scan on the chia harvester config.

plot_nfts:¶

A list of PlotNFTs to farm with. Will set pool_list on the chia pool config.

chia_daemon_port:¶

If unset defaults to 55469. Can be used to run multiple instances of Foxy-Farmer. Will set daemon_port on the chia config.

chia_farmer_port:¶

If unset defaults to 18447. Can be used to run multiple instances of Foxy-Farmer. Will set farmer.port on the chia config.

chia_farmer_rpc_port:¶

If unset defaults to 18559. Can be used to run multiple instances of Foxy-Farmer. Will set farmer.rpc_port on the chia config.

chia_harvester_rpc_port:¶

If unset defaults to 18560. Can be used to run multiple instances of Foxy-Farmer. Will set harvester.rpc_port on the chia config.

chia_wallet_rpc_port:¶

If unset defaults to 19256. Can be used to run multiple instances of Foxy-Farmer. Will set wallet.rpc_port on the chia config.

syslog_port:¶

If unset defaults to 11514. Used by the gigahorse and drplotter backends to read their logs. Can be used to run multiple instances of Foxy-Farmer. Will set logging.log_syslog_port on the chia config.

auto_update:¶

Set to true to enable automatic updating of Foxy-Farmer to the latest version when using the binary install method. Update checks are performed on startup and periodically. Self-Updating does not work with source or docker installs.

Bladebit only options¶

enable_og_pooling¶

Whether to enable OG pooling with Foxy-Pool for your OG plots.

parallel_decompressor_count:¶

The number of CPUs to be used for decompressing plots. If this is set to 0, then harvesting of compressed plots will be disabled. For GPU harvesting, set this value to 1. For CPU harvesting, set it to the number of CPUs you want to use for decompression (typically 1). Will set parallel_decompressor_count on the chia harvester config.

decompressor_thread_count:¶

The number of CPU threads that will participate in decompressing plots. This number multiplied by parallel_decompressor_count needs to less than or equal to the total number of CPU cores. Will set decompressor_thread_count on the chia harvester config.

use_gpu_harvesting:¶

Set to true to enable harvesting with a GPU. Note that in order to use this setting, your harvester must have an NVIDIA GPU with CUDA capability 5.2 and up, with at least 8GB of vRAM. Will set use_gpu_harvesting on the chia harvester config.

gpu_index:¶

If your harvester has multiple GPUs, use this setting to choose which one to use. If your harvester only has one GPU, then leave this set to 0. Will set gpu_index on the chia harvester config.

enforce_gpu_index:¶

Set to true if your harvester has more than one GPU and you want to use one other than the default of 0. Will set enforce_gpu_index on the chia harvester config.

decompressor_timeout:¶

The number of seconds for your decompressor to time out. The default value of 20 is typically fine. Will set decompressor_timeout on the chia harvester config.

disable_cpu_affinity:¶

This should typically be false. When it is false, when using multiple CPU decompressors, each with multiple threads, the threads for each decompressor will be assigned to different physical CPUs. This prevents them for competing over compute time. If it is set to true, the threads for each decompressor will be assigned to the same CPU. Will set disable_cpu_affinity on the chia harvester config.

max_compression_level_allowed:¶

The highest level of compression your harvester will support. In Chia version 2.0, the maximum level is 7. This will likely be increased in the future, but for now, you cannot increase it beyond the default. You can, however, set it to a lower number if desired. Will set max_compression_level_allowed on the chia harvester config.

Gigahorse only options¶

recompute_hosts:¶

Set your recompute hosts to use here, an empty array won't use any recompute servers. Accepts an array of strings or a string.

recompute_connect_timeout:¶

Timeout in milliseconds for connecting to a recompute server (default = 2000). Remove or set to null to unset.

recompute_retry_interval:¶

Interval in seconds how often to retry using a previously failed recompute server (default = 100). Remove or set to null to unset.

chiapos_max_cores:¶

The maximum number of CPU/GPU threads to use. Remove or set to null to unset.

chiapos_max_cuda_devices:¶

The maximum number of CUDA devices to use (overrides chiapos_max_gpu_devices). Remove or set to null to unset.

chiapos_max_opencl_devices:¶

The maximum number of OpenCL devices to use (overrides chiapos_max_gpu_devices). Remove or set to null to unset.

chiapos_max_gpu_devices:¶

The maximum number of CUDA or OpenCL devices. Remove or set to null to unset.

chiapos_opencl_platform:¶

Select which OpenCL platform to use when there are multiple OpenCL platforms on the system. Remove or set to null to unset.

chiapos_min_gpu_log_entries:¶

The minimum work size for GPU, can be set to modify transition to GPU based on C level (default = 21). Remove or set to null to unset.

cuda_visible_devices:¶

Specify a list of CUDA devices to use. Remove or set to null to unset.

DrPlotter only options¶

dr_plotter_client_token:¶

The client token to use to authenticate with your DrServer.

dr_server_ip_address:¶

The ip:port of your DrServer to use to connect to.

dr_server_use_ssl:¶

Set to true to connect to your DrServer using SSL (wss://). Only required if your DrServer is behind a SSL proxy or similar.