WAMF Configuration¶

WAMF is configured using a single YAML configuration file.

By default, the configuration file is located at:

config/config.yml

An example config file is included at:

config/config.yml.example

Complete Example¶

The following example shows a complete WAMF configuration with the default settings.

frigate:
  frigate_url: http://127.0.0.1:5000
  mqtt_server: your-mqtt-server
  mqtt_auth: false
  # mqtt_username: your-username
  # mqtt_password: your-password
  mqtt_port: 1883  # Optional, default: 1883
  mqtt_use_tls: false  # Optional, default: false
  mqtt_tls_insecure: false  # Optional, default: false
  # mqtt_tls_ca_certs: /path/to/ca.crt
  main_topic: frigate
  camera:
    - your-camera-name
  object: bird

# Frigate sub-label fallback: if WAMF's classifier is below threshold,
# WAMF will use Frigate's built-in bird classification sub_label if present.
# Enable in Frigate: https://docs.frigate.video/configuration/bird_classification

classification:
  model: model.tflite
  threshold: 0.7

bridge:
  enabled: false
  events_url: http://192.168.1.112:5000/api/events
  timeout_seconds: 1
  health_check_interval_seconds: 60

webui:
  port: 7767
  host: 0.0.0.0

live_view:
  url: http://

storage:
  database_path: ./data/speciesid.db

media:
  snapshots_path: ./media/wamf/snapshots
  clips_path: ./media/wamf/clips

retention:
  enabled: true
  snapshots_days: 90
  clips_days: 90
  delete_media: false
  orphan_scan_enabled: true
  delete_orphaned_media: false
  system_events_days: 90
  system_events_min_rows: 1000
  config_backups_max_files: 10
  species_overrides:
    Erithacus rubecula: # European Robin
      snapshots_days: 730
      clips_days: 180

admin:
  auth_enabled: true
  session_secret: "<long random session secret>"
  session_cookie_samesite: Lax
  session_cookie_secure: false
  password_hash: "<generated werkzeug password hash>"

api:
  token_auth_enabled: true
  token_hash: ""

The remainder of this page explains each section of the configuration file.

Frigate¶

The frigate section configures communication between WAMF and Frigate.

frigate:
  frigate_url: http://127.0.0.1:5000
  mqtt_server: your-mqtt-server
  mqtt_auth: false
  # mqtt_username: your-username
  # mqtt_password: your-password
  mqtt_port: 1883
  mqtt_use_tls: false
  mqtt_tls_insecure: false
  # mqtt_tls_ca_certs: /path/to/ca.crt
  main_topic: frigate
  camera:
    - your-camera-name
  object: bird

# Frigate sub-label fallback: if WAMF's classifier is below threshold,
# WAMF will use Frigate's built-in bird classification sub_label if present.
# Enable in Frigate: https://docs.frigate.video/configuration/bird_classification

WAMF receives detection events from Frigate over MQTT and retrieves snapshots and clips using the Frigate HTTP API.

Setting	Required	Description
`frigate_url`	Yes	URL of the Frigate server.
`mqtt_server`	Yes	MQTT broker hostname or IP address.
`mqtt_auth`	No	Enable MQTT username/password authentication.
`mqtt_username`	If `mqtt_auth` is enabled	MQTT username when authentication is enabled.
`mqtt_password`	If `mqtt_auth` is enabled	MQTT password when authentication is enabled.
`mqtt_port`	No	MQTT broker port. Default: `1883`.
`mqtt_use_tls`	No	Enable TLS encryption for MQTT connections.
`mqtt_tls_insecure`	No	Disable TLS certificate verification. Not recommended.
`mqtt_tls_ca_certs`	No	Path to a CA certificate file used to verify the MQTT broker when using TLS.
`main_topic`	No	Frigate MQTT topic prefix. Normally `frigate`.
`camera`	Yes	List of Frigate camera names monitored by WAMF.
`object`	Yes	Object type to classify. Normally `bird`.

Camera names

Camera names must match the corresponding Frigate camera names exactly.

Classification¶

The classification section controls how WAMF classifies detected objects.

classification:
  model: model.tflite
  threshold: 0.7

Setting	Required	Description
`model`	Yes	Path to the TensorFlow Lite model used for classification.
`threshold`	Yes	Minimum confidence score required for a classification to be accepted.

External Event Integration¶

The bridge section configures communication with external systems.

When enabled, WAMF can send system events to an external HTTP endpoint. This can be used to integrate WAMF with dashboards, notification systems, monitoring platforms, or other software capable of receiving event data.

bridge:
  enabled: false
  events_url: events_url: http://<external-host>:5000/api/events
  timeout_seconds: 1
  health_check_interval_seconds: 60

Setting	Required	Description
`enabled`	No	Enable or disable external event integration.
`events_url`	If enabled	HTTP endpoint that will receive WAMF system events.
`timeout_seconds`	No	Maximum time to wait for the remote server to respond.
`health_check_interval_seconds`	No	Interval, in seconds, between connectivity checks to the remote endpoint.

Web UI¶

The webui section configures the built-in WAMF web interface.

webui:
  port: 7767
  host: 0.0.0.0

Setting	Required	Description
`port`	Yes	TCP port used by the WAMF web interface.
`host`	Yes	Network interface to bind the web server to. Use `0.0.0.0` to listen on all interfaces.

Live View¶

The live_view section configures the live camera stream displayed in the WAMF dashboard.

live_view:
  url: http://

Setting	Required	Description
`url`	No	URL of the live stream, typically provided by go2rtc or another RTSP-to-web streaming service.

Storage¶

The storage section defines where WAMF stores its database.

storage:
  database_path: ./data/speciesid.db

Setting	Required	Description
`database_path`	Yes	Path to the SQLite database used by WAMF.

Media¶

The media section configures where snapshots and clips are stored.

media:
  snapshots_path: ./media/wamf/snapshots
  clips_path: ./media/wamf/clips

Setting	Required	Description
`snapshots_path`	Yes	Directory used to store captured snapshots.
`clips_path`	Yes	Directory used to store video clips.

Retention¶

The retention section controls how WAMF handles media, system events and configuration backups when the retention task runs.

retention:
  enabled: true
  snapshots_days: 90
  clips_days: 90
  delete_media: false
  orphan_scan_enabled: true
  delete_orphaned_media: false
  system_events_days: 90
  system_events_min_rows: 1000
  config_backups_max_files: 10
  species_overrides:
    Erithacus rubecula: # European Robin
      snapshots_days: 730
      clips_days: 180

Setting	Required	Description
`enabled`	No	Enable retention processing when the retention task is run.
`snapshots_days`	No	Number of days to retain snapshots.
`clips_days`	No	Number of days to retain video clips.
`delete_media`	No	Permanently delete expired media files. When disabled, retention is reported but files are not removed.
`orphan_scan_enabled`	No	Scan for media files that are no longer referenced by the database.
`delete_orphaned_media`	No	Delete orphaned media files found during scans.
`system_events_days`	No	Number of days to retain system events.
`system_events_min_rows`	No	Minimum number of system events to retain regardless of age.
`config_backups_max_files`	No	Maximum number of configuration backups to keep.
`species_overrides`	No	Species-specific retention overrides. Leave empty unless custom rules are required.

The retention task must be run separately, for example using cron. The enabled setting controls whether retention processing occurs when the task is executed; it does not schedule the task itself.

Administration¶

The admin section configures authentication for the WAMF administration interface.

admin:
  auth_enabled: true
  session_secret: "<long random session secret>"
  session_cookie_samesite: Lax
  session_cookie_secure: false
  password_hash: "<generated werkzeug password hash>"

Setting	Required	Description
`auth_enabled`	No	Enable or disable administrator authentication.
`session_secret`	Yes	Secret key used to sign user sessions. This value must remain the same between restarts.
`session_cookie_samesite`	No	SameSite policy applied to the session cookie.
`session_cookie_secure`	No	Only send the session cookie over HTTPS. Set to `true` when using HTTPS.
`password_hash`	Yes	Werkzeug password hash for the administrator account.

The administrator password and session secret are normally created during the WAMF initial setup process.

The administrator password can subsequently be changed from Admin → Password.

API¶

The api section controls authentication for protected WAMF API endpoints.

api:
  token_auth_enabled: true
  token_hash: ""

Setting	Required	Description
`token_auth_enabled`	No	Enable API token authentication.
`token_hash`	If authentication is enabled	SHA-256 hash of the configured API token.

API tokens should normally be generated and managed through Admin → API Token.

WAMF stores only the hash of the API token. The original token cannot be recovered later.

Generating a new token invalidates the previous token. Applications using the WAMF API must be updated with the new token.

For information about using the available API endpoints, see REST API.