Page 1 of 1

03 - Setup .env files

Posted: Fri Jan 05, 2024 3:21 am
by ogaland
.env.xx files are driving the whole client software and are referenced in docker-compose.yml

There are 3 .env files categories, all must be correctly set up for your config :
  • .env : general .env file
  • .env.watchdog : watchdog configuration .env file
  • .env.gpu.xx : gpu configuration .env file (one per graphic card)
Quickstart
If python is installed on your host you can use the script generate_env.py to generate a minimalist config

Code: Select all

python generate_env.py 
If you can't run it, you can check the env/examples directory, 2 examples are provided, one for a windows config with a 4070Ti and one for a linux config with six 3060Ti. You can get those files and adapt them to your setup.

1. Main .env file

This file define the following variables used at stack deployment. you cannot change this file name.
Variable Mandatory Usage Comment
COMPOSE_PROJECT_NAME Yes Prefix for docker stack Should be set to bpc
WATCHDOG_EXPOSED_PORT Yes Port to access watchdog web UI Default is port 6613, use https://<ip>:6613 for access

2. Watchdog .env.watchdog file

This file should define the gpu count on your system, it is mandatory for the watchdog to be able to correctly monitor system healthness. You can also define for each gpu the overclocking parameters you want. Name can be changed and is referenced in docker-compose.yml
Variable Mandatory Usage Comment
HOST_NAME No Name of your host If not set a uuid will be used
WORKER_GPU_COUNT Yes Number of video cards installed on system
GPU_MEM_CLOCK_xx No Custom memory clock of GPU number xx xx is the card id on 2 digit (from 00 to WORKER_GPU_COUNT-1)
GPU_POWER_LIMIT_xx No Custom memory clock of GPU number xx xx is the card id on 2 digit (from 00 to WORKER_GPU_COUNT-1)

3. Gpus .env.gpu.xx file

There should be one file per video card on the system, I recommend using same number as in .env.watchdog (xx is a 2 digit number starting from 00). Name can be changed and is referenced in docker-compose.yml

First section : Gpu worker settings
Variable Mandatory Usage Comment
WORKER_START_DELAY No This is a wait timer in seconds before the worker start processing blocks at boot time Recommended is setting this value different for each card to prevent simultaneous start and possible issues (ex 0,10,20 ...)
POOL_NAME Yes This is the puzzle challenge name to work on Currently Puzzle67 is the easiest to complete, it is recommended to join this pool
WORKER_NAME Yes This is your worker id, it must be a valid legacy bitcoin address (starting with 1 or 3) you control Your share of the reward will be sent to this address, you cannot change it once a block is completed, do not lose access to this address !
SERVER_IP Yes Server ip Should be set to puzzle.hyenasoft.com
SERVER_PORT Yes Server port Should be set to 6603

Second section : Gpu settings
Variable Mandatory Usage Comment
GPU_BRAND Yes Video card brand Should be set do Nvidia (only Nvidia gpu are supported yet)
GPU_NAME No Your video card model If not set, system won't be able to retrieve optimal settings from server database (if card is defined in db)
BIT_OVERRIDE No Range length to scan in bits If not set, minimal block size defined for the pool will be used
BLOCKS_OVERRIDE No CUDA block count to set on scan If not set and if card is defined in server database, database settings will be applied, in other cases scanner will use its default settings.
THREADS_OVERRIDE No Threads per CUDA block count If not set and if card is defined in server database, database settings will be applied, in other cases scanner will use its default settings.
POINTS_OVERRIDE No Points per threads If not set and if card is defined in server database, database settings will be applied, in other cases scanner will use its default settings.

Third section : Filter settings, for a quick setup just delete this section, you can later define the values to use. (TODO)
Variable Mandatory Usage Comment
FILTER_BASE_DISPLAY No
FILTER_BASE_DISPLAY_MIN No
FILTER_BASE_DISPLAY_MAX No
FILTER_BIT_BALANCE No
FILTER_BIT_BALANCE_PERCENT No
FILTER_PATTERN No
FILTER_PATTERN_xxx No