README: mention Docker

This commit is contained in:
George Hilliard committed 2020-07-03 14:07:20 -05:00
1 parent 8e293a4f1b
commit 10f1e584a8
1 file changed
+20
+20
View File
@@ -32,6 +32,8 @@ Neolink does not support other cameras such as the RLC-420, since they already [
In the future Neolink will be much easier to install.
For now, follow these steps.
### Windows/Linux
1. [Install Gstreamer][gstreamer] from the most recent MSI installer on Windows, or your package manager on Linux.
2. If you are using Windows, add the following to your `PATH` environment variable:
@@ -57,6 +59,24 @@ neolink --config my_config.toml
[gstreamer]: https://gstreamer.freedesktop.org/documentation/installing/index.html
[ci-download]: https://github.com/thirtythreeforty/neolink/actions?query=branch%3Amaster
### Docker
A Docker image is also available containing Neolink and all its dependencies.
The image is `thirtythreeforty/neolink`.
Port 8554 is exposed, which is the default listen port.
You must mount a configuration file (see below) into the container at `/etc/neolink.toml`.
Here is a sample launch commmand:
```
docker run \
--restart=on-failure \
--volume=$PWD/config.toml:/etc/neolink.toml \
thirtythreeforty/neolink
```
The Docker image is "best effort" and intended for advanced users; questions about running Docker are outside the scope of Neolink.
## Configuration
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).