upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNsable-sh <nsable-sh@noreply.git.bitflash.network>2026-08-07 11:30:49 -0300
committerBitflash <admin@bitflash.network>2026-08-07 15:05:31 -0300
commit5c2e66b70ab3c15603a6e2d7a4ea9e02f3cd0604 (patch)
tree360c43d69ce716ad16e1e3868911a3e660c16302 /README.md
parent8c2e375600c0eb9bedb8f85ee4fa860825f23521 (diff)
pool: write dashboard status JSON
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6746e02..af56081 100644
--- a/README.md
+++ b/README.md
@@ -219,6 +219,11 @@ Open **Options** from the menu bar. Under Mining Mode:
219 219
220Pool announcements are published on Nostr with live status fields, so external tools can query the latest pool state by `.btf` address. 220Pool announcements are published on Nostr with live status fields, so external tools can query the latest pool state by `.btf` address.
221 221
222Pool operators also write a local `pool_status.json` every ten seconds. By
223default it is created in the data directory; use `-poolstatusfile=PATH` to write
224it somewhere a dashboard or web sync can read. The file is informational only:
225nodes still discover pools through Nostr and `.btf`, not through any web domain.
226
222**Participant** — mine to someone else's pool. Enter or select the pool's `.btf` address and enable Start Mining. 227**Participant** — mine to someone else's pool. Enter or select the pool's `.btf` address and enable Start Mining.
223 228
224SRBMiner and XMRig connect to operator pools through the `.btf` path: 229SRBMiner and XMRig connect to operator pools through the `.btf` path:
@@ -236,6 +241,7 @@ xmrig -a rx/0 -o POOL_BTF_ADDRESS -u YOUR_BTF_ADDRESS -p x
236./bitflash -nogui # node only 241./bitflash -nogui # node only
237./bitflash -nogui -gen # node + solo mining 242./bitflash -nogui -gen # node + solo mining
238./bitflash -nogui -gen -operator # pool operator 243./bitflash -nogui -gen -operator # pool operator
244./bitflash -nogui -gen -operator -poolstatusfile=/var/www/api/pools.json
239./bitflash -nogui -gen -participant=POOL_BTF_ADDRESS # mine to pool 245./bitflash -nogui -gen -participant=POOL_BTF_ADDRESS # mine to pool
240``` 246```
241 247