A CLI tool has runtime modes, not a request

2026-08-25 16:42:39 -04:00
parent 1f9915f074
commit d25b147a56
2 changed files with 25 additions and 1 deletions
@@ -44,6 +44,17 @@
 //   php mesh_traffic_sample.php            append one sample per mesh peer
 //   php mesh_traffic_sample.php --show     print what it would record, write nothing
 //
+// CONFIGURATION
+//   master.conf
+//     HOST1, HOST2, …   the hostname of each node in the mesh. Every HOST<n> with a non-empty
+//                       value becomes a name matched against tailscale's peer list; a peer that
+//                       is not one of them is skipped, so a device that merely shares the
+//                       tailnet is never recorded as mesh traffic. No HOST<n> set at all means
+//                       there is no mesh to sample and the run exits without writing.
+//
+//   Nothing is read from host*.conf. This samples the local tailscale daemon, so it needs to
+//   know which peers count and nothing about how to reach them.
+//
 // DEPENDS ON
 //   tailscale status --json     the counters
 //   include/config.php          DATA_DIR, vv_conf_vars() for the HOST* list