Installation

1. Clone the repository

git clone https://github.com/jimididit/nokwatch.git
cd nokwatch

2. Create and activate a virtual environment

python3 -m venv .venv
# Windows (PowerShell): .venv\Scripts\Activate.ps1
# Linux/macOS: source .venv/bin/activate

3. Install dependencies

pip install -r requirements.txt

For a smaller install on limited-resource devices (no AI, no screenshots, no test deps), use:

pip install -r requirements-minimal.txt

4. Configure environment

cp .env.example .env

Edit .env: set SECRET_KEY, SMTP settings, and optionally OPENAI_API_KEY and ENCRYPTION_KEY. For Gmail, use an App Password, not your normal password.

5. Run the app

python app.py

Open http://localhost:5000 in your browser. The database is created automatically on first run.

Optional: Install a plugin

Plugins extend Nokwatch with new job types (e.g. Scanner for listing pages). From the Web UI, open Modules to install plugins, or from the command line:

pip install nokwatch-scan

Restart the app so it picks up the plugin. See Plugins for details.

See Deployment for production (e.g. gunicorn and systemd on Raspberry Pi).