MyFavMirrors/moonfire-nvr
1
0
Fork 0
mirror of https://github.com/scottlamb/moonfire-nvr.git synced 2025-12-08 00:32:26 -05:00
Code Issues Packages Projects Releases Wiki Activity

add a contributing guide

Browse Source 
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.
This commit is contained in:
Scott Lamb
2021-04-01 15:20:39 -07:00
parent 4d4d78ba64
commit 770e76d342
4 changed files with 148 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@@ -1,5 +1,8 @@
[![CI](https://github.com/scottlamb/moonfire-nvr/workflows/CI/badge.svg)](https://github.com/scottlamb/moonfire-nvr/actions?query=workflow%3ACI)
* [Introduction](#introduction)
* [Documentation](#documentation)
# Introduction
Moonfire NVR is an open-source security camera network video recorder, started
@@ -12,6 +15,9 @@ 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
less than 10% of the machine's total CPU.
**Help wanted to make it great! Please see the [contributing
guide](CONTRIBUTING.md).**
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.
There's also an experimental live view UI.
@@ -25,7 +31,7 @@ There's also an experimental live view UI.
</tbody>
</table>
There's no support yet for motion detection, no https/SSL/TLS support (you'll
There's no support yet for motion detection, no https/TLS support (you'll
need a proxy server, as described [here](guide/secure.md)), and only a
console-based (rather than web-based) configuration UI.
@@ -34,50 +40,36 @@ compatibility guarantees: configuration and storage formats may change from
version to version. There is an [upgrade procedure](guide/schema.md) but it is
not for the faint of heart.
I hope to add features such as salient motion detection. It's way too early to
make promises, but it seems possible to build a full-featured
hobbyist-oriented multi-camera NVR that requires nothing but a cheap machine
with a big hard drive. I welcome help; see [Getting help and getting
involved](#help) below. There are many exciting techniques we could use to
make this possible:
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:
* 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.
* taking advantage of on-camera analytics. This is the lowest CPU usage option,
although many cameras' analytics aren't as good as what can be done on the NVR,
they're hard to experiment with, and even when they use modern ML-based
approaches, their built-in models can't be retrained.
* 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.
# Documentation
* [Contributing](CONTRIBUTING.md)
* [License](LICENSE.txt) —
[GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html)
with [https://spdx.org/licenses/GPL-3.0-linking-exception.html](GPL-3.0-linking-exception)
for OpenSSL.
* [Installing](guide/install.md)
* [Building from source](guide/build.md)
* [UI Development](guide/developing-ui.md)
* [Troubleshooting](guide/troubleshooting.md)
* [Wiki](https://github.com/scottlamb/moonfire-nvr/wiki) has notes on
several camera models. Please add yours!
# <a name="help"></a> Getting help and getting involved
Please email the
[moonfire-nvr-users](https://groups.google.com/d/forum/moonfire-nvr-users)
mailing list with questions, or just to say you love/hate the software and
why. You can also file bugs and feature requests on the
[github issue tracker](https://github.com/scottlamb/moonfire-nvr/issues).
I'd welcome help with testing, development (in Rust, JavaScript, and HTML),
user interface/graphic design, and documentation. Please email the mailing
list if interested. Pull requests are welcome, but I encourage you to discuss
large changes on the mailing list or in a github issue first to save effort.
* [Guides](guide/)
* [Installing](guide/install.md)
* [Building from source](guide/build.md)
* [UI Development](guide/developing-ui.md)
* [Troubleshooting](guide/troubleshooting.md)
* [Design documents](design/)
* [Wiki](https://github.com/scottlamb/moonfire-nvr/wiki) has hardware
recommendations and notes on several camera models. Please add yours!