From 643953845a9cc136f14f0ca7fec3af0d9100ebf2 Mon Sep 17 00:00:00 2001 From: QuantumEntangledAndy Date: Mon, 16 Aug 2021 11:28:30 +0700 Subject: [PATCH] Doc update to include battery cameras and doc fixes --- README.md | 11 +++++++++++ docs/unix_setup.md | 1 - sample_config.toml | 10 ++++++++-- 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8c93ce9..552a7bb 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,14 @@ docker run \ The Docker image is "best effort" and intended for advanced users; questions about running Docker are outside the scope of Neolink. +If you use a UDP only camera, such as a battery camera you will need to either +use `--net=host` or setup a [macvlan](https://docs.docker.com/network/macvlan/) +for the docker image that supports UDP broadcast. +This is because UDP requires that udp broadcast messages are transmitted across +the docker network interface, however this is [not possible in the default +bridging mode](https://github.com/docker/for-linux/issues/637) + + ## Configuration **Note**: for a more comprehensive setup tutorial, refer to the @@ -120,6 +128,9 @@ about running Docker are outside the scope of Neolink. 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). +The address can be a camera UID, in this case your network must support UDP +broadcasts. Battery cameras exclusively use this UDP mode so you must always +use a UID in the address field. Each `[[cameras]]` block creates a new camera; the `name` determines the RTSP path you should connect your client to. diff --git a/docs/unix_setup.md b/docs/unix_setup.md index 40886ef..cb4ee02 100644 --- a/docs/unix_setup.md +++ b/docs/unix_setup.md @@ -42,7 +42,6 @@ Here are some examples for commands of package managers libgstrtspserver-1.0-0 \ libgstreamer1.0-0 \ libgstreamer-plugins-bad1.0-0 \ - libgstreamer-plugins-good1.0-0 \ gstreamer1.0-plugins-good \ gstreamer1.0-plugins-bad ``` diff --git a/sample_config.toml b/sample_config.toml index cbe4fa2..74228df 100644 --- a/sample_config.toml +++ b/sample_config.toml @@ -14,7 +14,7 @@ bind = "0.0.0.0" # Choose if the client is required to provide a certificate signed by the server's CA. # none|requested|required - default none -# tls_client_auth = "required" +# tls_client_auth = "required" # You can password protect the rtsp server mount points by adding users # like the following me and someone. If you do not add [[users]] @@ -50,7 +50,13 @@ name = "storage shed" username = "admin" password = "987654321" address = "192.168.1.245:9000" +# The address could instead be set to a camera UID like this +# address = "ABCD01234567890EFG" +# If you use an NVR that relays several camera connections you can choose which +# camera to connect to with by setting the `channel_id` +# # By default channel_id = 0. Eg the first connected camera on the device -# Note this counts from 0. An 8 channel NVR would have channels 0 through 7 +# **Note**: that unlike in the offical client the numbering starts from 0 not 1. +# An 8 channel NVR would have channels 0 through 7 # channel_id = 1