Quick Start¶
This guide covers the minimum steps required to connect a new WAMF v0.4.3 installation to Frigate and begin recording bird observations.
Before continuing:
- WAMF should be installed and running.
- Frigate should already be detecting the
birdobject. - Frigate and WAMF should have access to the same MQTT broker.
- WAMF must be able to access the Frigate HTTP API.
See Installation if WAMF has not yet been installed.
1. Check Frigate¶
WAMF v0.4.3 receives detection events from Frigate over MQTT and retrieves associated media through the Frigate HTTP API.
Confirm that:
- Frigate is running.
- MQTT is enabled in Frigate.
- The required camera is configured in Frigate.
- The camera is tracking the
birdobject. - Snapshots are available through the Frigate API.
- The Frigate HTTP API is accessible from the WAMF host.
The camera name configured in WAMF must exactly match the camera name configured in Frigate.
See Frigate Configuration for more information.
2. Open WAMF¶
Open the WAMF web interface:
For a new installation, WAMF automatically creates the files required for initial configuration.
On a fresh installation with administrator authentication enabled, WAMF prints a
private, single-use /setup#token=... link to the startup logs:
Open the link within 15 minutes, choose and confirm a password of at least eight characters, then sign in through the normal login page. JavaScript must be enabled. WAMF no longer prints a temporary administrator password.
If setup expires, restart WAMF to obtain a new link. Restarting while setup is pending invalidates the previous link; opening or refreshing the page does not renew it.
Keep the setup link private
Anyone with the unused link and network access can set the administrator password. Restrict startup and centralized logs to trusted administrators, disable proxy request-body capture for setup, and use HTTPS or a trusted tunnel for remote password setup.
The printed link uses a loopback address by default. For access from another
machine, replace its host and published port with those of your WAMF deployment,
while retaining the /setup#token=... portion. The loopback address is not an
access control. An optional webui.public_base_url can supply the external
origin; see Authentication.
Existing valid administrator passwords, API credentials and session secrets are preserved. Provisioned installations receive no setup link. Malformed authentication configuration stops startup rather than resetting credentials.
Operational workers pause until administrator setup succeeds. They start automatically when setup completes if Frigate configuration is ready; otherwise complete the Frigate/MQTT configuration and use Save & Restart.
3. Configure Frigate and MQTT¶
A new WAMF installation starts in setup mode until the required external services have been configured.
Open the WAMF configuration page and enter the settings for your environment.
The important Frigate and MQTT settings are:
- Frigate HTTP API address
- MQTT broker address
- MQTT port
- MQTT authentication settings, if required
- MQTT topic
- Frigate camera name
A typical installation uses:
Use the actual values configured for your environment.
The Frigate camera name entered in WAMF must exactly match the identifier used by Frigate.
For example, if the Frigate configuration contains:
the WAMF camera name must be:
4. Save the Configuration¶
Save the WAMF configuration after entering the required settings.
WAMF will indicate when a restart is required for configuration changes to take effect.
Use the WAMF restart control when prompted.
After restarting, WAMF should leave setup mode and connect to the configured services.
5. Check System Health¶
Open the WAMF administration interface and check the system health information.
Confirm that the required WAMF services are operating normally and that the MQTT connection is available.
If WAMF cannot communicate with Frigate or MQTT, recheck:
- Hostnames or IP addresses
- MQTT port
- MQTT authentication settings
- Frigate HTTP API address
- Network connectivity between the systems
6. Test a Detection¶
Wait for MQTT event subscription ready in the logs before testing. Retained
MQTT deliveries are skipped; use a new live event after subscription is ready.
Trigger or wait for a bird detection on the Frigate camera configured in WAMF.
For a successful detection, WAMF should:
- Receive the Frigate event over MQTT.
- Retrieve the event snapshot from the Frigate API.
- Classify the bird species.
- Store the observation in the WAMF database.
- Archive the associated media.
- Display the observation in the WAMF dashboard.
The first classification may take slightly longer while the classifier and supporting components initialise.
7. Check the Dashboard¶
Open:
A successfully processed detection should appear in the WAMF interface.
You can then use the dashboard and observation views to review detections and identified species.
Troubleshooting¶
If no observations appear, check:
- The Frigate camera name exactly matches the camera configured in WAMF.
- Frigate is detecting the
birdobject. - WAMF is connected to the MQTT broker.
- WAMF is using the same MQTT topic as Frigate.
- WAMF can access the Frigate HTTP API.
- Frigate can provide the event snapshot.
- WAMF storage directories are writable.
- The classification result meets the configured confidence threshold.
For Docker installations, check the WAMF logs with:
See the FAQ troubleshooting checklist and the full Configuration guide for configuration details.