MyFavMirrors
/
moonfire-nvr
mirror of https://github.com/scottlamb/moonfire-nvr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
moonfire-nvr/README.md

81 lines
3.8 KiB
Markdown
Raw Normal View History

replacing travis-ci with github actions
2020-12-23 01:21:17 -05:00
[![CI](https://github.com/scottlamb/moonfire-nvr/workflows/CI/badge.svg)](https://github.com/scottlamb/moonfire-nvr/actions?query=workflow%3ACI)
add a contributing guide Questions about how to contribute come up from time to time, eg: https://github.com/scottlamb/moonfire-nvr/issues/84#issuecomment-656065208 https://github.com/scottlamb/moonfire-nvr/issues/68#issuecomment-688938108 I hope this helps answer them. I think github adds a couple links to a file called CONTRIBUTING or CONTRIBUTING.md so this filename gives it some extra visibility.
2021-04-01 18:20:39 -04:00
* [Introduction](#introduction)
* [Documentation](#documentation)
Initial commit, with basic functionality.
2016-01-02 01:06:47 -05:00
# Introduction
Moonfire NVR is an open-source security camera network video recorder, started
fix a couple README formatting mistakes
2016-11-25 16:03:58 -05:00
by Scott Lamb &lt;<slamb@slamb.org>&gt;. It saves H.264-over-RTSP streams from
IP cameras to disk into a hybrid format: video frames in a directory on
update the README to reflect the SQLite schema
2016-11-25 16:00:27 -05:00
spinning disk, other data in a SQLite3 database on flash. It can construct
`.mp4` files for arbitrary time ranges on-the-fly. It does not decode,
analyze, or re-encode video frames, so it requires little CPU. It handles six
1080p/30fps streams on a [Raspberry Pi
2](https://www.raspberrypi.org/products/raspberry-pi-2-model-b/), using
less than 10% of the machine's total CPU.
add a contributing guide Questions about how to contribute come up from time to time, eg: https://github.com/scottlamb/moonfire-nvr/issues/84#issuecomment-656065208 https://github.com/scottlamb/moonfire-nvr/issues/68#issuecomment-688938108 I hope this helps answer them. I think github adds a couple links to a file called CONTRIBUTING or CONTRIBUTING.md so this filename gives it some extra visibility.
2021-04-01 18:20:39 -04:00
**Help wanted to make it great! Please see the [contributing
guide](CONTRIBUTING.md).**
add a basic Javascript UI The Javascript is pretty amateurish I'm sure but at least it's something to iterate from. It's already much more pleasant for browsing through videos in several ways: * more responsive to load only a day at a time rather than 90+ days * much easier to see the same time segment on several cameras * more pleasant to have the videos load as a popup rather than a link that blows away your position in an enormous list * exposes the fancier .mp4 generation options: splitting at lengths other than the default, trimming to an arbitrary start and end time, including a subtitle track with timestamps. There's a slight regression in functionality: I didn't match the former top-level page which showed how much camera used of its disk allocation and the total duration of video. This is exposed in the JSON API, so it shouldn't be too hard to add back.
2017-10-22 00:54:27 -04:00
So far, the web interface is basic: a filterable list of video segments,
with support for trimming them to arbitrary time ranges. No scrub bar yet.
Prepare v0.6.3 release ...including changelog and new screenshots in the README.
2021-03-31 18:21:09 -04:00
There's also an experimental live view UI.
<table>
<tbody>
<tr valign=top>
<td><a href="screenshots/list.png"><img src="screenshots/list.png" width=360 height=345 alt="list view screenshot"></a></td>
<td><a href="screenshots/live.jpg"><img src="screenshots/live.jpg" width=360 height=212 alt="live view screenshot"></a></td>
</tr>
</tbody>
</table>
add a contributing guide Questions about how to contribute come up from time to time, eg: https://github.com/scottlamb/moonfire-nvr/issues/84#issuecomment-656065208 https://github.com/scottlamb/moonfire-nvr/issues/68#issuecomment-688938108 I hope this helps answer them. I think github adds a couple links to a file called CONTRIBUTING or CONTRIBUTING.md so this filename gives it some extra visibility.
2021-04-01 18:20:39 -04:00
There's no support yet for motion detection, no https/TLS support (you'll
document proxy setup in guide/secure.md (for #26) The guide is not as quick to follow and amateur-friendly as I'd like. A few things that might improve matters: * complete #27 (built-in https+letsencrypt), so that when not sharing the port, users don't need to use nginx or certbot. * more ubiquitous IPv6 (out of my control but should happen over time) to reduce need to share the port * embed a dynamic DNS client * support UPnP Internet Gateway Device Control Protocol (if common routers have this enabled? probably not for security reasons.) It's progress, though. Enough that I think I'll merge the auth branch into master shortly.
2018-12-27 17:00:15 -05:00
need a proxy server, as described [here](guide/secure.md)), and only a
console-based (rather than web-based) configuration UI.
add a basic Javascript UI The Javascript is pretty amateurish I'm sure but at least it's something to iterate from. It's already much more pleasant for browsing through videos in several ways: * more responsive to load only a day at a time rather than 90+ days * much easier to see the same time segment on several cameras * more pleasant to have the videos load as a popup rather than a link that blows away your position in an enormous list * exposes the fancier .mp4 generation options: splitting at lengths other than the default, trimming to an arbitrary start and end time, including a subtitle track with timestamps. There's a slight regression in functionality: I didn't match the former top-level page which showed how much camera used of its disk allocation and the total duration of video. This is exposed in the JSON API, so it shouldn't be too hard to add back.
2017-10-22 00:54:27 -04:00
prep v0.7.7
2023-08-03 17:03:48 -04:00
Moonfire NVR is currently at version 0.7.7. Until version 1.0, there will be no
Initial commit, with basic functionality.
2016-01-02 01:06:47 -05:00
compatibility guarantees: configuration and storage formats may change from
schema version 1 The advantages of the new schema are: * overlapping recordings can be unambiguously described and viewed. This is a significant problem right now; the clock on my cameras appears to run faster than the (NTP-synchronized) clock on my NVR. Thus, if an RTSP session drops and is quickly reconnected, there's likely to be overlap. * less I/O is required to view mp4s when there are multiple cameras. This is a pretty dramatic difference in the number of database read syscalls with pragma page_size = 1024 (605 -> 39 in one test), although I'm not sure how much of that maps to actual I/O wait time. That's probably as dramatic as it is due to overflow page chaining. But even with larger page sizes, there's an improvement. It helps to stop interleaving the video_index fields from different cameras. There are changes to the JSON API to take advantage of this, described in design/api.md. There's an upgrade procedure, described in guide/schema.md.
2016-12-21 01:08:18 -05:00
version to version. There is an [upgrade procedure](guide/schema.md) but it is
not for the faint of heart.
Initial commit, with basic functionality.
2016-01-02 01:06:47 -05:00
add a contributing guide Questions about how to contribute come up from time to time, eg: https://github.com/scottlamb/moonfire-nvr/issues/84#issuecomment-656065208 https://github.com/scottlamb/moonfire-nvr/issues/68#issuecomment-688938108 I hope this helps answer them. I think github adds a couple links to a file called CONTRIBUTING or CONTRIBUTING.md so this filename gives it some extra visibility.
2021-04-01 18:20:39 -04:00
I hope to add features such as video analytics. In time, we can build
a full-featured hobbyist-oriented multi-camera NVR that requires nothing but
a cheap machine with a big hard drive. There are many exciting techniques we
could use to make this possible:
Initial commit, with basic functionality.
2016-01-02 01:06:47 -05:00
add a contributing guide Questions about how to contribute come up from time to time, eg: https://github.com/scottlamb/moonfire-nvr/issues/84#issuecomment-656065208 https://github.com/scottlamb/moonfire-nvr/issues/68#issuecomment-688938108 I hope this helps answer them. I think github adds a couple links to a file called CONTRIBUTING or CONTRIBUTING.md so this filename gives it some extra visibility.
2021-04-01 18:20:39 -04:00
* avoiding CPU-intensive H.264 encoding in favor of simply continuing to use
the camera's already-encoded video streams. Cheap IP cameras these days
provide pre-encoded H.264 streams in both "main" (full-sized) and "sub"
(lower resolution, compression quality, and/or frame rate) varieties. The
"sub" stream is more suitable for fast computer vision work as well as
remote/mobile streaming. Disk space these days is quite cheap (with 4 TB
drives costing about $100), so we can afford to keep many camera-months
of both streams on disk.
* off-loading on-NVR analytics to an inexpensive USB or M.2 neural network
accelerator and hardware H.264 decoders.
* taking advantage of on-camera analytics. They're often not as accurate, but
they're the best way to stretch very inexpensive NVR machines.
Initial commit, with basic functionality.
2016-01-02 01:06:47 -05:00
Reorganize and expand documentation
2017-10-02 01:02:39 -04:00
# Documentation
Initial commit, with basic functionality.
2016-01-02 01:06:47 -05:00
add a contributing guide Questions about how to contribute come up from time to time, eg: https://github.com/scottlamb/moonfire-nvr/issues/84#issuecomment-656065208 https://github.com/scottlamb/moonfire-nvr/issues/68#issuecomment-688938108 I hope this helps answer them. I think github adds a couple links to a file called CONTRIBUTING or CONTRIBUTING.md so this filename gives it some extra visibility.
2021-04-01 18:20:39 -04:00
* [Contributing](CONTRIBUTING.md)
shorten per-file copyright headers I'm tired of all the boilerplate, so use the new GPL-3.0-linking-exception license identifier instead in all the server components. I left the ui stuff alone because I'm just going to replace it (#111). Add a checker for the header because it's easy to forget.
2021-02-17 16:28:48 -05:00
* [License](LICENSE.txt) —
[GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html)
really fix backward link in README
2021-04-27 01:21:39 -04:00
with [GPL-3.0-linking-exception](https://spdx.org/licenses/GPL-3.0-linking-exception.html)
shorten per-file copyright headers I'm tired of all the boilerplate, so use the new GPL-3.0-linking-exception license identifier instead in all the server components. I left the ui stuff alone because I'm just going to replace it (#111). Add a checker for the header because it's easy to forget.
2021-02-17 16:28:48 -05:00
for OpenSSL.
add some more doc links
2021-04-01 18:40:31 -04:00
* [Change log](CHANGELOG.md) / release notes.
config file reference and doc reorganization
2023-01-06 12:40:41 -05:00
* [Guides](guide/), including:
add a contributing guide Questions about how to contribute come up from time to time, eg: https://github.com/scottlamb/moonfire-nvr/issues/84#issuecomment-656065208 https://github.com/scottlamb/moonfire-nvr/issues/68#issuecomment-688938108 I hope this helps answer them. I think github adds a couple links to a file called CONTRIBUTING or CONTRIBUTING.md so this filename gives it some extra visibility.
2021-04-01 18:20:39 -04:00
* [Installing](guide/install.md)
* [Building from source](guide/build.md)
config file reference and doc reorganization
2023-01-06 12:40:41 -05:00
* [Securing Moonfire NVR and exposing it to the Internet](guide/secure.md)
add a contributing guide Questions about how to contribute come up from time to time, eg: https://github.com/scottlamb/moonfire-nvr/issues/84#issuecomment-656065208 https://github.com/scottlamb/moonfire-nvr/issues/68#issuecomment-688938108 I hope this helps answer them. I think github adds a couple links to a file called CONTRIBUTING or CONTRIBUTING.md so this filename gives it some extra visibility.
2021-04-01 18:20:39 -04:00
* [UI Development](guide/developing-ui.md)
* [Troubleshooting](guide/troubleshooting.md)
config file reference and doc reorganization
2023-01-06 12:40:41 -05:00
* [References](ref/), including:
user admin api improvements
2023-01-08 04:14:03 -05:00
* [Configuration file](ref/config.md)
* [JSON API](ref/api.md)
add a contributing guide Questions about how to contribute come up from time to time, eg: https://github.com/scottlamb/moonfire-nvr/issues/84#issuecomment-656065208 https://github.com/scottlamb/moonfire-nvr/issues/68#issuecomment-688938108 I hope this helps answer them. I think github adds a couple links to a file called CONTRIBUTING or CONTRIBUTING.md so this filename gives it some extra visibility.
2021-04-01 18:20:39 -04:00
* [Design documents](design/)
* [Wiki](https://github.com/scottlamb/moonfire-nvr/wiki) has hardware
add some more doc links
2021-04-01 18:40:31 -04:00
recommendations, notes on several camera models, etc. Please add more!