Skip to content

Commit

Permalink
Add new foxy-farmer config options and update guide with auth command
Browse files Browse the repository at this point in the history
  • Loading branch information
felixbrucker committed Oct 26, 2023
1 parent c7ab098 commit c52290a
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
27 changes: 27 additions & 0 deletions docs/proof-of-spacetime/foxy-farmer/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,30 @@ The config file currently consists of these config options:

### `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.

### `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.
3 changes: 3 additions & 0 deletions docs/proof-of-spacetime/foxy-gh-farmer/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ The config file currently consists of these config options:
### `pool_payout_address`:
: The Chia address you want your pool rewards credited to. This will be used as `payout_instructions` for all PlotNFTs.

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

### `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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
2. Run Foxy-GH-Farmer once to generate a `foxy-gh-farmer.yaml` as well as the `.foxy-gh-farmer` directory in your users home directory.
3. Import your 24 word mnemonic using `./foxy-gh-farmer keys add`
4. Join the pool by running `./foxy-gh-farmer join-pool`. This will spin up the wallet service, wait till its synced, join all PlotNFTs to the Foxy-Pool and shutdown the wallet service again once done. This process can take up to 30 minutes.
5. Run Foxy-GH-Farmer and check out the Pools "My Farmer" tab!
5. Run Foxy-GH-Farmer and check out the Pools "My Farmer" tab! You can use `./foxy-gh-farmer auth` to generate the pool login link.

=== "Manual setup"

Expand Down Expand Up @@ -45,4 +45,4 @@
2. Run Foxy-Farmer once to generate a `foxy-farmer.yaml` as well as the `.foxy-farmer` directory in your users home directory.
3. Import your 24 word mnemonic using `./foxy-farmer keys add`
4. Join the pool by running `./foxy-farmer join-pool`. This will spin up the wallet service, wait till its synced, join all PlotNFTs to the Foxy-Pool and shutdown the wallet service again once done. This process can take up to 30 minutes.
5. Run Foxy-Farmer and check out the Pools "My Farmer" tab!
5. Run Foxy-Farmer and check out the Pools "My Farmer" tab! You can use `./foxy-farmer auth` to generate the pool login link.

0 comments on commit c52290a

Please sign in to comment.