prplanit/bulkvs-ip-sync repository overview

⁠bulkvs-ip-sync

DDNS for a BulkVS⁠ SIP trunk.

BulkVS authenticates SIP trunks by source IP — you register your public IP as an IP Host (/ipHost, the portal's Host → Add screen). On a dynamic WAN that entry goes stale every time the IP rotates and calls break. bulkvs-ip-sync watches the site's current public IP and keeps the /ipHost allowlist in sync — the same job cloudflare-ddns⁠ does for DNS, pointed at BulkVS instead.

It's a single static Go binary shipped FROM scratch (non-root, read-only, no shell) — the whole thing is stdlib, no dependencies.

⁠What it does each pass

1. Read the current public IPv4 from a Cloudflare-trace endpoint (https://1.1.1.1/cdn-cgi/trace) — the same source cloudflare-ddns uses.
2. PUT /ipHost the current IP (upsert), tagged with your label plus the auto-appended (bulkvs-ip-sync) marker.
3. If pruning is on, DELETE every other /ipHost entry carrying that same marked Description — old rotated IPs and manual leftovers clean themselves up.

The marker is the ownership boundary. The tool appends (bulkvs-ip-sync) to your label and writes the composite (e.g. pbx-host (bulkvs-ip-sync)). Only entries whose Description equals that exact composite are ever read as "ours" or pruned — anything else, including a hand-made entry that happens to share your label, is left untouched. Because the marker is always appended, the label may even be blank.

⁠Configuration (env)

Authenticate with either the API username + password/token pair (the common case — we base64 it for you) or the portal's pre-computed Basic Auth header.

⁠Run

docker run --rm \
  -e BULKVS_API_USER=... -e BULKVS_API_KEY=... \
  -e BULKVS_HOST_DESCRIPTION=pbx-host \
  prplanit/bulkvs-ip-sync

Start with DRY_RUN=true the first time to see exactly what it would add/prune.

⁠Caveats

• Auth scheme + JSON shapes follow BulkVS's documented /ipHost fields (IP, Description, MaxOut) and HTTP Basic auth. The API responses aren't fully documented publicly — verify list decoding against your live account and adjust the struct tags in src/bulkvs if BulkVS wraps the array.
• IPv4 only for now (IP-based SIP auth is v4 in practice).

⁠Layout

cmd/bulkvs-ip-sync   entrypoint + loop
src/config        env config
src/ipsource      public-IP detection (cloudflare.trace)
src/bulkvs        /ipHost API client
src/reconcile     upsert-current + prune-stale
src/version       build-time identity