Nokwatch docs

Introduction

Nokwatch is a lightweight Python-based website monitoring tool. It can run on low-resource devices like a Raspberry Pi and monitors multiple websites for content changes. When your criteria are met, you get notified by email, Discord, or Slack.

Why Nokwatch?

  • Lightweight — Designed for Raspberry Pi and similar devices; minimal dependencies with an optional minimal install.
  • Flexible — String or regex matching, JSON/API monitoring with JSONPath, Basic Auth, custom headers, and cookies.
  • Multi-channel — Email, Discord webhooks, and Slack webhooks; multiple channels per monitor with cooldown.
  • Web UI — Dark-themed, mobile-friendly interface to add monitors, run checks, and view history.
  • Extensible — Optional plugins (e.g. Scanner for listing pages) add new job types; more plugins in development.

Features at a glance

  • Multiple monitors with separate intervals and patterns
  • Content matching (contains / does not contain; string or regex)
  • HTTP status and response time alerts
  • JSON/API monitoring with JSONPath
  • Auth: Basic Auth, headers, cookies
  • Tags, templates, and Smart Setup (optional AI)
  • Check history with diff and optional screenshots
  • Export/Import monitors as JSON
  • Plugins (e.g. Scanner for listing pages; more in development)

Requirements

Python 3.10+, an SMTP account for email, and optionally an OpenAI API key for Smart Setup and AI content detection.

Next: Getting Started