.env.example

# Copy to .env and fill in, or set UNIFI_MAP_ENV to a file kept elsewhere.
# Search order: --env-file, $UNIFI_MAP_ENV, ./.env, ~/.config/unifi-map/env
# Real environment variables always override file contents.
#
# See docs/credentials.md for the long version.

# Hostname or IP of the console or controller, optionally with a port. No path.
# A scheme is optional; https:// is assumed.
UNIFI_HOST=unifi.example.com

# An API key, created in the UniFi OS settings under the integrations section.
# This is the only supported authentication method; username and password auth
# was removed. A key is not a password, can be revoked on its own, needs no
# session, and avoids the local-versus-cloud-account trap entirely.
#
# This tool only reads, so read-only permission would be enough. Note that on the
# version tested, UniFi offers no way to issue a key that restricted; see
# SECURITY.md for what a key can actually do.
UNIFI_API_KEY=CHANGE_ME

# Which site to read. A controller can manage several sites; if you never
# created a second one, this is "default" and you can leave it alone.
#
# This wants the site's INTERNAL name, which is not the label shown in the UI.
# Find it in the web UI address bar (the segment after /site/), or from
# GET /proxy/network/api/self/sites, where you want the "name" field and not
# "desc" ("desc" is the UI label).
UNIFI_SITE=default

# true (the default) verifies the certificate. Use false for a bare IP, since
# consoles serve a self-signed certificate there. Any other value is treated as
# a path to a CA bundle.
UNIFI_VERIFY_TLS=true

# Alternative spellings, so an existing credential file needs no renaming:
#   UDM_HOST, UDM_API_KEY, UDM_SITE, UDM_VERIFY_TLS
# UNIFI_* wins if both spellings are set.