------------------------------------------------------ F A R M G O D | C L O U D . K o l l e k t o r ------------------------------------------------------ R E A D M E _ ------------------------------------- # 00 - PRE-REQUISITES AND INFOS ------------------------------------ // INFO _ The 'FARMGOD|CLOUD.Kollektor' serves as the automated data bridge between your ASICs and the 'FARMGOD|CLOUD' platform. It operates in the background to detect, interface, and fetch real-time telemetry from your hardware and more. // REQUIREMENTS _ - FarmGod|Cloud Account (https://farmgod.cloud) - Linux AMD64 (Debian/Ubuntu/Fedora/..) - or Linux ARM64 (64-bit OS, e.g. Raspberry Pi 4/5 with Raspberry Pi OS 64-bit) // iMPORTANT NOTES _ - No FarmGod|Cloud Account needed if you are using a private VPS. - Must be installed in a location where it has network connectivity to reach the IPs of your miners. - Must be initially run as root or with sudo (due to pkg/deps installation). // ADDiTiONAL HELP _ https://www.youtube.com/@FARMGOD_io ------------------------------------- # 01 - DOWNLOAD (LINUX) ------------------------------------ // LINK _ https://get.farmgod.cloud/FARMGOD.Kollektor.Linux.amd64.tar.gz // DIRECT DOWNLOAD _ wget --no-check-certificate https://get.farmgod.cloud/FARMGOD.Kollektor.Linux.amd64.tar.gz // EXTRACT _ tar xzf FARMGOD.Kollektor.Linux.amd64.tar.gz cd FARMGOD.Kollektor // ARM64 _ On 64-bit ARM, use 'FARMGOD.Kollektor.Linux.arm64.tar.gz' instead (same link and commands, 'arm64' in place of 'amd64'). // RUN _ sudo ./launch NOTE _ Do NOT install/run as user 'root' as there might be issues during package installation. ------------------------------------- # 02 - SETUP ------------------------------------ // ViDEO-GUiDE https://www.youtube.com/watch?v=k35soYpepIQ // STEP 1 _ INSTALL DEPENDENCIES Choose 'y' to install crucial dependencies. Without them the tool will not (properly) work. // STEP 2 _ CUSTOM API-URL VPS users only - Provide your unique id. // STEP 3 _ API LOGIN Provide your 'FarmGod|Cloud' Login and Password and hit enter to proceed. // DONE _ The tool is now configured and ready to use. ------------------------------------- # 03 - USAGE INSTRUCTIONS ------------------------------------ The 'CLOUD.Kollektor' acts as the local bridge for your mining operation. While all primary management, monitoring, and organization are handled through Grafana (UI), this tool provides optional low-level utilities for your 'Device-Sets'. // MAIN MENU 1 | VIEW DEVICE-SETS _ 2 | CREATE A DEVICE-SET _ 3 | CONNECT YOUR ASICs _ 4 | DELETE A DEVICE-SET _ 5 | SITEMAP-iMPORT _ x | EXiT // DESCRIPTION _ - - - - - - - - - - - - - - - 1 / VIEW DEVICE-SETS - - - - - - - - - - - - - - - Select this option to explore detailed information about your 'Device-Sets'. - - - - - - - - - - - - - - - 2 / CREATE A DEVICE-SET - - - - - - - - - - - - - - - Opt for this choice to effortlessly establish a new 'Device-Set' and seamlessly connect ASICs to it. - STEP 1 _ Provide a descriptive name for your new 'Device-Set'. // OPTIONAL _ STEP 2 _ Choose to scan for ASICS and connect them to the 'Device-Set'. STEP 3 _ Provide an IP/IP-Range to scan (eg. 192.168.1.* or 192.168.50-51.* or 192.168.1.0/24). STEP 4 _ Optional: Provide a port to scan on (Default: 4028). STEP 5 _ Optional: Provide the miners webif user (Default: root). STEP 6 _ Optional: Provide the miners webif pass (Default: empty). // DONE _ The 'Device-Discovery' service initiates a network scan for compatible ASICs within the specified IP/range, seamlessly integrating them into the newly created 'Device-Set.' Once incorporated, the 'Kollektor.Service' automatically gathers data from the miners (refer to #02 - SETUP / PROVISIONING MODE). - - - - - - - - - - - - - - - 3 / CONNECT YOUR ASICs - - - - - - - - - - - - - - - Choose this option if you have 'AUTO-REFRESH' disabled (refer to #02) or if you want to add (more) ASICs to an existing 'Device-Set' or reassign existing ASICs to a different 'Device-Set' manually. - STEP 1 _ Choose a 'Device-Set' from the list. STEP 2 _ Provide an IP or IP-Range to scan (eg. 192.168.1.* or 192.168.50-51.* or 192.168.1.0/24). STEP 3 _ Optional: Provide a port to scan on (Default: 4028). STEP 4 _ Optional: Provide the miners webif user (Default: root). STEP 5 _ Optional: Provide the miners webif pass (Default: empty). // DONE _ Again, the 'Device-Discovery' service will start scanning your network for supported ASICs it finds on the given IP/range and add them to the 'Device-Set' you have chosen. Once added, data will either be automatically collected from the miners via the 'Kollektor.Service' (refer to #02 - SETUP / PROVISIONING MODE). - - - - - - - - - - - - - - - 4 / DELETE A DEVICE-SET - - - - - - - - - - - - - - - Select this option when you wish to remove a 'Device-Set' along with all the associated miners and data. - STEP 1 _ Choose a 'Device-Set' from the list. STEP 2 _ Delete the set. // DONE _ This action deletes the selected 'Device-Set,' its connected ASICs, and all associated data. NOTE _ In 'Multi-Location' mode you can only delete the device-sets that have been created using the particular tool installation. - - - - - - - - - - - - - - - 5 / SITEMAP-IMPORT - - - - - - - - - - - - - - - Choose this option to efficiently provision your mining operation via a simple file import process. Particularly beneficial for large-scale operations, this method eliminates manual configuration, creating all your 'Device-Sets' seamlessly and scanning for compatible ASICs to add them to the specific set. - STEP 1 _ Place your 'sitemap.txt' file in the 'CLOUD.Kollektor' root directory. STEP 2 _ Confirm with (y) to initiate the 'Sitemap-Importer'. // DONE Upon completion, all sets will be created/updated and configured. If 'Auto-Refresh' is enabled (see #02 - SETUP / AUTO REFRESH), the 'Device-Discovery' service will automatically scan for supported ASICs within the configured IP/range and add them to the specific 'Device-Set'. SITEMAP.TXT _ Ensure the 'sitemap.txt' file follows this structure. (Fields marked with * are mandatory.) NAME1* IP* PORT WEBIF_USER WEBIF_PASS NAME2* IP* PORT WEBIF_USER WEBIF_PASS NAME3* IP* PORT WEBIF_USER WEBIF_PASS EXAMPLE CONTENT _ C_01 192.168.10.* C_02 192.168.20.* 50500 C_03 192.168.30-31.* 4028 root pass NOTE _ Name must be alphanumeric. Underscores are allowed. If you omit PORT, USER, and/or PASS, default values will be applied: '4028' for Port, 'root' for Webif User, and 'blank' for Webif Pass. Existing 'Device-Set' configurations will be automatically updated to reflect any desired changes, such as different IP addresses, ports, and other settings specified in the imported 'sitemap.txt' file. - - - - - - - - - - - - - - - X / EXIT - - - - - - - - - - - - - - - Choose this option if you want to exit the 'CLOUD.Kollektor' tool. ------------------------------------- # 04 - UPDATING THE TOOL ------------------------------------ To update the 'CLOUD.Kollektor' tool, execute the following command on your linux shell: sudo ./update NOTE _ All your settings and configurations will be preserved. ------------------------------------- # 05 - TROUBLESHOOTING ------------------------------------ 0 / Be sure to check out our Youtube channel for guides: https://www.youtube.com/@FARMGOD_io 1 / General issues related to the tool: If you encounter any issues during launching the app, logging in, or while using the app, refer to the 'launch and/or kollektor' log files located in the '%APPDIR%/log/'. 2 / Device detection issues: If you encounter any issues during device detection, network scans, refer to the log files located in the '%APPDIR%/log/%DEVICESET%/' directory for possible error information and troubleshooting assistance. 3 / Sitemap import issues: If you encounter any issues during importing your 'sitemap.txt' file, refer to the import log files located in '%APPDIR%/log/'. - Still stuck? Reach out on t.me/farmgod_io ------------------------------------- # 06 - SUPPORTED ASiCs ------------------------------------ We use a strict model detection mechanism to accurately utilize manufacturer specs. Some models, especially Whatsminers, have many submodels with slightly different specifications. Therefore, not all ASICs may be detected immediately. We continuously add support for more models and submodels to ensure full coverage. // Bitmain / Antminer - - - - - - - - - - - - - L3/L3+/L3++/L5/L7/L9/S9/S9i/S9j/S9k/S9_SE/S9_Hydro/S15/T15/T17/T17+/T17+/T17e/S17/S17+/S17+/S17e/S17Pro/S19/T19/S19_A/S19Pro/S19Pro+/S19Pro_A/S19Pro_110/S19Pro_104/S19J/S19J88/S19JPro/S19JPro_A/S19JPro+/S19KPro/S19XP/S21/T21 // MicroBT / Whatsminer - - - - - - - - - - - - - M1/M2/M3/M10/M20/M20P/M20S/M20S+/M21/M21S/M21S+/M29S/M30/M30K/M30L/M30S/M30S+/M30S++/M31/M31H/M31S/M31SE/M31S+/M32/M32S/M33/M33S/M33S+/M33S++/M34S+/M36S/M36S+/M36S++/M39/M50/M50S/M50S+/M50S++/M53/M53S/M53S+/M56/M56S/M56S+/M59/M60/M60S/M63/M63S/M66S // Canaan / AvalonMiner - - - - - - - - - - - - - 1026/1047/1066/1066/1066Pro/1126Pro-S/1166Pro/1166Pro-S/1166Pro-N/1246 ... and more! ------------------------------------- # !! - JOIN US: ------------------------------------ Telegram: t.me/farmgod_io Youtube: youtube.com/@farmgod_io Twitter: twitter.com/farmgod_io www.farmgod.io ------------------------------------------------------ (c) 2025 FARMGOD LLC - All rights reserved. ------------------------------------------------------