diff --git a/README.md b/README.md index 392f8d6..5a23f67 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ ![CI](https://github.com/thirtythreeforty/neolink/workflows/CI/badge.svg) Neolink is a small program that acts as a proxy between Reolink IP cameras and normal RTSP clients. -Certain cameras, such as the Reolink B800, do not implement ONVIF or RTSP, but instead use a proprietary protocol only compatible with their apps and NVRs (any camera that uses "port 9000" will likely be using this protocol). +Certain cameras, such as the Reolink B800, do not implement ONVIF or RTSP, but instead use a proprietary "Baichuan" protocol only compatible with their apps and NVRs (any camera that uses "port 9000" will likely be using this protocol). -Neolink allows you to use NVR software such as ZoneMinder or Blue Iris to receive video from these cameras instead. +Neolink allows you to use NVR software such as Shinobi or Blue Iris to receive video from these cameras instead. Your NVR software connects to Neolink, which forwards the video stream from the camera. The Neolink project is not affiliated with Reolink in any way; everything it does has been reverse engineered. @@ -13,15 +13,18 @@ The Neolink project is not affiliated with Reolink in any way; everything it doe ## Installation In the future Neolink will be much easier to install. -Currently you need to install Gstreamer. +Currently you need to [install Gstreamer][gstreamer]. On Windows, add the following to your path: ``` %GSTREAMER_1_0_ROOT_X86_64%\bin ``` +Note that Chocolatey does this automatically. + Now you can download and run an artifact [from continuous integration][ci-download]. +[gstreamer]: https://gstreamer.freedesktop.org/documentation/installing/index.html [ci-download]: https://github.com/thirtythreeforty/neolink/actions?query=branch%3Amaster Launch Neolink from a shell, passing a configuration file: @@ -34,10 +37,20 @@ neolink --config my_config.toml Copy and modify the `sample_config.toml` to specify the address, username, and password for each camera (if there is no password, you can omit that line). Each `[[cameras]]` block creates a new camera; the `name` determines the RTSP path you should connect your client to. +Currently Neolink cannot auto-detect cameras like the official clients do; you must specify the IP address directly. By default Neolink serves on all IP addresses on port 8554. You can modify this by changing the `bind` parameter. +You can change the Neolink log level by setting the `RUST_LOG` environment variable (not in the configuration file) to one of `error`, `warn`, `info`, `debug`, or `verbose`. + +## Stability + +Neolink has had minimal testing. +In particular it does not handle retries or errors well; please exercise restraint while integrating it into a security system. + +The formats of all configuration files and APIs is subject to change as required while it is pre-1.0. + ## Development Neolink is written in Rust, and binds to Gstreamer to provide RTSP server functionality. @@ -64,7 +77,10 @@ A Wireshark dissector is available for the BC wire protocol in the `dissector` d It dissects the BC header and also allows viewing the deobfuscated XML in command messages. To use it, copy or symlink it into your Wireshark plugin directory; typically this is `~/.local/lib/wireshark/plugins/` under Linux. +Currently the dissector does not attempt to decode the Baichuan "extension" messages except `binaryData`. +This will change in the future as reverse engineering needs require. + ## License Neolink is free software, released under the GNU Affero General Public License v3. -This means that if you incorporate it into a piece of software available over the network, you must be prepared to offer that software's source code to your users. +This means that if you incorporate it into a piece of software available over the network, you must offer that software's source code to your users.