update the README to reflect the SQLite schema

This commit is contained in:
Scott Lamb 2016-11-25 13:00:27 -08:00
parent 7c5a90b8fb
commit 98720911c7

View File

@ -1,13 +1,19 @@
# Introduction # Introduction
Moonfire NVR is an open-source security camera network video recorder, started Moonfire NVR is an open-source security camera network video recorder, started
by Scott Lamb <slamb@slamb.org>. Currently it is basic: it saves by Scott Lamb <slamb@slamb.org>. It saves H.264-over-RTSP streams from IP
H.264-over-RTSP streams from IP cameras to disk as .mp4 files and provides a cameras to disk into a hybrid format: video frames in a directory on
simple HTTP interface for listing and viewing fixed-length segments of video. spinning disk, other data in a SQLite3 database on flash. It can construct
It does not decode, analyze, or re-encode video frames, so it requires little `.mp4` files for arbitrary time ranges on-the-fly. It does not decode,
CPU. It handles six 720p/15fps streams on a [Raspberry Pi analyze, or re-encode video frames, so it requires little CPU. It handles six
2](https://www.raspberrypi.org/products/raspberry-pi-2-model-b/), using roughly 1080p/30fps streams on a [Raspberry Pi
5% of the machine's total CPU. 2](https://www.raspberrypi.org/products/raspberry-pi-2-model-b/), using
less than 10% of the machine's total CPU.
So far, the web interface is basic: just a table with links to one-hour
segments of video. Although the backend supports generating `.mp4` files for
arbitrary time ranges, you have to construct URLs by hand. There's also no
support for motion detection, no authentication, and no config UI.
This is version 0.1, the initial release. Until version 1.0, there will be no This is version 0.1, the initial release. Until version 1.0, there will be no
compatibility guarantees: configuration and storage formats may change from compatibility guarantees: configuration and storage formats may change from