WISPMapbeta

Docs / The collector

Collector settings

Every setting in the collector's .env file, credential profiles for routers and SNMP devices, and the intervals you set in WISPMap.

Updated 10 November 2026

The collector keeps its settings in .env, in the folder you installed it in (usually wispmap-collector). Only your user can read that file, and its contents never leave the machine.

After changing it, restart the collector:

cd wispmap-collector && docker compose up -d

The basics

Setting What it is
WISPMAP_URL WISPMap's address: https://wispmap.gigahost.co.za.
WISPMAP_TOKEN The collector's token, from its page in Admin → Collectors.
WISPMON_USER The read-only RouterOS user that exists on every router (usually wispmon).
WISPMON_PASSWORD Its password. Put it in single quotes; it can't contain a single quote itself.
COLLECTOR_HOSTNAME The name shown on the Collectors page.

SNMP credentials

For devices of the SNMP kind (other makes). Use one of these:

Setting What it is
SNMP_COMMUNITY The read-only community for SNMP v2c.
SNMP_V3_USER The SNMP v3 user. Setting it switches the profile to v3.
SNMP_V3_AUTH_PROTO SHA (default), SHA256, SHA512 or MD5.
SNMP_V3_AUTH_KEY The authentication password.
SNMP_V3_PRIV_PROTO AES (default), AES256 or DES.
SNMP_V3_PRIV_KEY The privacy (encryption) password. Leave it out for authentication without encryption.

Use SNMP v3 with authentication and privacy where your devices support it: v2c sends the community in plain text.

Credential profiles

Every device in WISPMap has a credential profile, default unless you change it. The profile names a set of credentials in .env, so the passwords themselves never reach WISPMap:

  • RouterOS devices use WISPMON_USER and WISPMON_PASSWORD. Today only the default profile is supported for RouterOS, so use the same read-only user on every router.
  • SNMP devices with the default profile use the settings above. Another profile name adds a suffix: a device with the profile towers uses SNMP_COMMUNITY_TOWERS, or SNMP_V3_USER_TOWERS, SNMP_V3_AUTH_KEY_TOWERS and so on. Dashes become underscores and letters become capitals: the profile east-pop is SNMP_COMMUNITY_EAST_POP.
# radios on the towers: v3
SNMP_V3_USER_TOWERS=wispmap
SNMP_V3_AUTH_KEY_TOWERS='<auth password>'
SNMP_V3_PRIV_KEY_TOWERS='<privacy password>'
# the UPSs: v2c
SNMP_COMMUNITY_UPS='<community>'

If a device names a profile that isn't in .env, its page says which setting to add.

Optional

Setting What it is
COLLECTOR_TAG Which collector release to run (Docker image tag). Default latest; 0.8 stays on 0.8.x updates.
WISPMAP_POLL_THREADS RouterOS devices polled at the same time (default 64). Raise it for 1 000+ routers or many slow ones.

Intervals (set in WISPMap)

How often the collector pings, polls and sends is set per collector on its page in Admin → Collectors, not in .env. The collector picks up a change within a minute.

Setting Choices Default
Ping every 10, 15, 30 or 60 s 30 s
Poll devices every 30 s, 60 s, 2 min or 5 min 60 s
Send to server every 10, 15, 30 or 60 s 10 s

A device counts as down after 3 missed pings in a row (about 90 seconds at 30-second pings). Ping every 10 seconds if you want to hear sooner.