Skip to content

Installation

WAMF can be deployed using Docker or installed directly on a Linux host.

For WAMF v0.4.0, Docker is the recommended deployment method for most users.

Supported Deployment Methods

Docker

Docker provides the simplest and most consistent way to deploy WAMF.

Benefits include:

  • Simple installation
  • Isolated runtime environment
  • Easy upgrades and container recreation
  • Persistent configuration, database and media storage
  • Suitable for home servers, virtual machines and dedicated hosts
  • Compatible with Docker Compose and Portainer

The official WAMF v0.4.0 image is available from the GitHub Container Registry:

ghcr.io/wamf-project/wamf:0.4.0

See the Docker Deployment guide for installation instructions.

Native Installation

Native installation is intended primarily for development, testing and advanced users who want direct control over the WAMF runtime environment.

A native WAMF v0.4.0 installation requires Python 3.11.

Native installation provides:

  • Direct access to the Python environment
  • Easier debugging and development
  • Greater control over services and filesystem permissions
  • Access to WAMF without a container runtime

Docker is recommended for normal deployments unless you specifically require a native installation.

System Requirements

WAMF v0.4.0 requires:

  • A Linux operating system
  • A multi-core processor
  • Sufficient storage for the WAMF database, snapshots and clips
  • Network connectivity to Frigate and MQTT
  • Docker for the recommended container deployment

8 GB RAM is recommended, although actual memory requirements depend on the host workload and other services running alongside WAMF.

For native installations, Python 3.11 is required.

WAMF v0.4.0 Dependencies

WAMF v0.4.0 uses Frigate as its detection source.

Before installing WAMF, ensure you have:

  • A working Frigate installation
  • At least one camera configured in Frigate
  • The bird object being detected on the required camera
  • An MQTT broker accessible to both Frigate and WAMF
  • MQTT enabled in Frigate
  • Network access from WAMF to the Frigate HTTP API

WAMF receives detection events from Frigate over MQTT and retrieves the associated media through the Frigate HTTP API.

Support for additional detection sources is planned for future WAMF releases.

Frigate Compatibility

WAMF v0.4.0 has been validated with:

  • Frigate 0.17.2
  • Frigate 0.18.0

WAMF does not require a particular Frigate detector such as Coral, OpenVINO or TensorRT. Detector configuration is handled by Frigate.

See Frigate Configuration for the WAMF-specific Frigate requirements.

Before You Begin

You should have:

  • Administrative access to the WAMF host
  • Basic familiarity with Docker or Linux administration
  • A working Frigate installation
  • The address of the MQTT broker used by Frigate
  • The address of the Frigate HTTP API
  • The Frigate camera name you want WAMF to monitor

The camera identifier configured in WAMF must exactly match the camera name configured in Frigate.

Choose an Installation Method

For most installations:

Docker Deployment

After WAMF is running, continue to:

Quick Start

The Quick Start guide covers the initial WAMF setup and connection to Frigate.