Merge pull request #40 from isZumpo/docker-volume-cleanup

Define docker volumes & add docker documentation

Dockerfile

@@ -24,5 +24,12 @@ COPY --from=build /root/src/BirdNET-Go/bin /usr/bin/
 COPY --from=build /usr/local/lib/libtensorflowlite_c.so /usr/local/lib/libtensorflowlite_c.so
 RUN ldconfig
 
+# Add symlink to /config directory where configs can be stored 
+VOLUME /config
+RUN mkdir -p /root/.config && ln -s /config /root/.config/birdnet-go
+
+VOLUME /data
+WORKDIR /data
+
 ENTRYPOINT ["/usr/bin/birdnet-go"]
 CMD ["realtime"]

README.md

@@ -31,6 +31,22 @@ BirdNET-Go is an AI solution for continuous avian monitoring and identification
 Ready to run binaries can be found from releases section https://github.com/tphakala/BirdNET-Go/releases/
 Archives also contains libtensorflowlite_c library.
 
+### Docker
+
+```
+docker run -ti \
+  -p 8080:8080 \
+  -v /path/to/config:/config \
+  -v /path/to/data:/data \
+  ghcr.io/tphakala/birdnet-go:latest
+```
+
+| Parameter | Function |
+| :----: | --- |
+| `-p 8080` | BirdNET-GO webserver port. |
+| `-v /config` | Config directory in the container. |
+| `-v /data` | Data such as database and recordings. |
+
 ## Compiling for Linux
 
 ### Install TensorFlow Lite C library and setup headers for compile process