From 7fbb1a7625dcc9707e191c5bef2e4757023df4ff Mon Sep 17 00:00:00 2001 From: Nardo86 Date: Mon, 11 Dec 2023 16:20:52 +0100 Subject: [PATCH] docs: Updated Readme --- README.md | 53 +++++++++++++++++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 4285978..92ad907 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,16 @@ # ZONEMINDER - DOCKER ARM64 -This is a simple debian image with the ZoneMinder installed following the official instructions https://wiki.zoneminder.com/Debian_10_Buster_with_Zoneminder_1.36.x_from_ZM_Repo; due to the fact that there is no official arm64 package it has been build directly from the sources https://zoneminder.readthedocs.io/en/stable/installationguide/packpack.html via -`OS=debian DIST=bullseye ARCH=aarch64 utils/packpack/startpackpack.sh` +This is a simple debian image with the ZoneMinder installed following the official instructions https://wiki.zoneminder.com/Debian_10_Buster_with_Zoneminder_1.36.x_from_ZM_Repo; due to the fact that there is no official arm64 package it has been build directly from the sources https://zoneminder.readthedocs.io/en/stable/installationguide/packpack.html via `OS=debian DIST=bullseye ARCH=aarch64 utils/packpack/startpackpack.sh` Because of the ssmtp deprecation the mail server installed is msmtp and a default configuration file prepared for GMail will be created in /config/msmtprc, be sure to set the correct path /usr/bin/msmtp in zoneminder options. -Furthermore the image is prepared for working with SWAG(let's encrypt) image or there is an environment for the self-signed certificate option. +Furthermore the image is prepared for working with [SWAG from LinuxServer.io](https://docs.linuxserver.io/general/swag/) image or there is an environment for the self-signed certificate option. Image available at https://hub.docker.com/r/nardo86/zoneminder Feel free to consider donating if my work helped you! https://paypal.me/ErosNardi -_Tested on my Raspberry Pi 4 with 64bit OS and SWAG_ +_Tested on my MiniPC Intel x64 and SWAG_ **USAGE** @@ -19,37 +18,51 @@ _Tested on my Raspberry Pi 4 with 64bit OS and SWAG_ Just run the image publishing the port and setting the ENV variables, the shm dedicated and mounting the folder you wish to map. `docker run -d \` - -` --name=ZoneMinder \` - -` -p 443:443/tcp \` - +` --name=zoneMinder \` +` -p 443:443 \` ` -e TZ=Europe/Rome \` - ` -e SELFSIGNED=0 \` - ` -e FQDN=your.fqdn \` - -` --shm-size=1.5g \` - +` --shm-size=1g \` ` -v /mystorage/ZoneMinder/config:/config \` - ` -v /mystorage/ZoneMinder/zmcache:/var/cache/zoneminder \` - ` -v /mystorage/Swag/etc/letsencrypt/live:/sslcert/live \` - ` -v /mystorage/Swag/etc/letsencrypt/archive:/sslcert/archive \` - ` --restart unless-stopped \` - ` nardo86/zoneminder` +Or add to your docker compose + +`zoneminder:` +` image: nardo86/zoneminder` +` container_name: zoneminder` +` ports:` +` - "443:443"` +` environment:` +` - "TZ=Europe/Rome"` +` - "SELFSIGNED=0"` +` - "FQDN=your.fqdn"` +` volumes:` +` - "/mystorage/ZoneMinder/config:/config"` +` - "/mystorage/ZoneMinder/zmcache:/var/cache/zoneminder"` +` - "/mystorage/Swag/etc/letsencrypt/live:/sslcert/live"` +` - "/mystorage/Swag/etc/letsencrypt/archive:/sslcert/archive"` +` shm_size: '1gb'` +` deploy:` +` resources:` +` limits:` +` cpus: '2'` +` reservations:` +` cpus: '0.1'` +` memory: 50M` +` restart: unless-stopped` + The FQDN will be used for configuring Apache2; the SELFSIGNED flag will generate a selfsigned certificate if needed else, in case of using the SWAG certificate, the system find the correct folder. The /config folder will contain msmtp and mysql configuration. The shm-size will be the quantity of RAM dedicated to /dev/shm, the size depends on the number and settings of the video sources to monitor, check ZoneMinder configuration for further information.* -**be sure to not reserve too much RAM to this machine or the docker server wil start to paging and eventually becoming unresponsible** +**be sure to not reserve too much RAM to this machine or the docker server will start to paging and eventually becoming unresponsible** To access the Zoneminder gui, browse to: https://your.fqdn:443/zm