diff --git a/Home.md b/Home.md deleted file mode 100644 index 611f81a..0000000 --- a/Home.md +++ /dev/null @@ -1,55 +0,0 @@ -# go-netops - -Network operations toolkit for managing UniFi infrastructure. Part of the [Core Go ecosystem](https://forge.lthn.ai/core). - -## Installation - -```bash -go get forge.lthn.ai/core/go-netops -``` - -**Requires**: Go 1.25+, depends on `forge.lthn.ai/core/go` - -## Package Map - -| Import Path | Description | -|---|---| -| `go-netops/unifi` | UniFi controller client: sites, clients, networks, routes, devices | - -## Quick Start - -```go -import "forge.lthn.ai/core/go-netops/unifi" - -// Create client from config file / env vars / flags -client, err := unifi.NewFromConfig("", "", "", "", nil) - -// List all sites -sites, err := client.GetSites() - -// List connected clients -clients, err := client.GetClients(unifi.ClientFilter{}) - -// List infrastructure devices -devices, err := client.GetDeviceList("default", "") -``` - -See [[UniFi-Client]] for the full API reference. - -## Configuration - -Authentication is resolved from three sources (highest priority first): - -1. **Flag overrides** via `core unifi config --url/--user/--pass/--apikey` -2. **Environment variables**: `UNIFI_URL`, `UNIFI_USER`, `UNIFI_PASS`, `UNIFI_APIKEY`, `UNIFI_INSECURE` -3. **Config file**: `~/.core/config.yaml` keys `unifi.url`, `unifi.user`, `unifi.pass`, `unifi.apikey` - -Default controller URL: `https://10.69.1.1` - -## Dependencies - -- `github.com/unpoller/unifi/v5` -- UniFi SDK - -## Licence - -EUPL-1.2