https://github.com/ry-ops/capture-cadence
Automate snapshots and video clips from UniFi cameras — beautifully scheduled, locally stored, and easy to manage.
https://github.com/ry-ops/capture-cadence
docker python raspberrypi unifi
Last synced: 2 months ago
JSON representation
Automate snapshots and video clips from UniFi cameras — beautifully scheduled, locally stored, and easy to manage.
- Host: GitHub
- URL: https://github.com/ry-ops/capture-cadence
- Owner: ry-ops
- License: mit
- Created: 2025-05-11T13:38:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-15T19:40:33.000Z (about 1 year ago)
- Last Synced: 2025-06-24T15:43:17.633Z (about 1 year ago)
- Topics: docker, python, raspberrypi, unifi
- Language: Python
- Homepage: https://ry-ops.dev/capture-cadence
- Size: 5.23 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CaptureCadence
**Scheduled full-page website screenshot automation.**
[](https://github.com/ry-ops/capture-cadence)
[](https://nodejs.org)
[](https://docker.com)
[](./LICENSE)
> **Note:** This project is archived and no longer in active development or production use. The codebase is preserved as-is for reference.
---
## What is CaptureCadence?
CaptureCadence is a lightweight tool that takes full-page screenshots of websites on a configurable schedule. Add any URL, set an interval in minutes, and it automatically captures the page using Puppeteer's headless Chrome, saving the result as an efficient WebP image.
It was built for monitoring website changes, creating visual dashboards, and archiving periodic snapshots of web content.
---
## How It Works
1. User adds a site via the web UI (URL, interval, save path, filename)
2. Express server stores the config in `urls.json` and schedules a `setInterval`
3. When the interval fires, Puppeteer launches headless Chrome
4. Navigates to the URL, waits for `networkidle0` (all requests complete)
5. Takes a full-page screenshot in WebP format
6. Saves to the configured directory — on restart, all jobs reload automatically
---
## Components
| Component | Description |
|-----------|-------------|
| **Express Server** | HTTP server on port 3000, serves UI, handles API requests, manages scheduler |
| **Puppeteer Engine** | Headless Chrome automation — full-page capture with network idle detection |
| **Web UI** | Minimal form-based interface for adding screenshot jobs |
| **urls.json** | File-based persistence — jobs survive server restarts |
| **Docker** | Containerized deployment with volume mount for screenshot output |
---
## Features
- Full-page screenshots of any URL using headless Chrome
- Per-site configurable intervals (in minutes)
- Custom save paths and filenames
- WebP format for efficient storage
- Persistent job configuration (survives restarts)
- Docker-ready with volume mount support
- Overwrite mode (fixed filename) or accumulate mode (timestamped)
---
## Project Structure
```
capture-cadence/
├── server.js # Express server, scheduler, API endpoints
├── puppeteer.js # Headless Chrome screenshot capture logic
├── urls.json # Persistent job configuration
├── ui/
│ └── index.html # Web interface
├── Dockerfile # Docker build (Node.js 20)
├── package.json # Dependencies (express, puppeteer, body-parser)
└── docs/ # Architecture diagrams
```
---
## Tech Stack
| Category | Technology |
|----------|-----------|
| **Runtime** | Node.js 18+ |
| **Server** | Express.js |
| **Browser** | Puppeteer (headless Chrome) |
| **Image Format** | WebP |
| **Persistence** | File-based (urls.json) |
| **Deployment** | Docker (Node.js 20 base) |
---
## API
| Endpoint | Method | Description |
|----------|--------|-------------|
| `/` | GET | Serves the web UI |
| `/add-site` | POST | Add a screenshot job (`{url, interval, savePath, baseName}`) |
| `/screenshots/*` | GET | Serves captured screenshot files |
---
## License
[MIT](./LICENSE)