mattmatician/zoneminder repository overview

Thanks to the LinuxServer.io⁠ team, I bring you a container release featuring:

• regular and timely application updates
• easy user mappings (PGID, PUID)
• custom base image with s6 overlay

⁠mattmatician/zoneminder⁠

Zoneminder⁠ is a full-featured, open source, state-of-the-art video surveillance software system.

⁠Supported Architectures

I utilise the docker manifest for multi-platform awareness. More information is available from docker here⁠ and I utilise the hard work of the LinuxServer.io⁠ team after their announcement here⁠.

Simply pulling mattmatician/zoneminder:latest should retrieve the correct image for your arch.

The architectures supported by this image are:

⁠Application Setup

Start the container and configure your cameras to be monitored.

For further setup options of remotes etc, check out the Zoneminder documentation website, Zoneminder⁠.

⁠Usage

Here are some example snippets to help you get started creating a container.

⁠docker-compose (recommended, click here for more info⁠)

---
services:
  db:
    environment:
      MYSQL_DATABASE: zm
      MYSQL_PASSWORD: zmpass
      MYSQL_ROOT_PASSWORD: somezoneminder
      MYSQL_USER: zmuser
      TZ: Europe/London
    image: mysql:5.7.34
    restart: unless-stopped
    volumes:
    - mysql_data:/var/lib/mysql:rw
  zoneminder:
    environment:
      ZM_DB_HOST: db
      ZM_DB_NAME: zm
      ZM_DB_PASSWORD: zmpass
      ZM_DB_USER: zmuser
      TZ: Europe/London
    image: mattmatician/zoneminder:latest
    ports:
    - 8080:8080/tcp
    restart: unless-stopped
    shm_size: 4g
    volumes:
    - zm_config:/config:rw
    - zm_content:/app:rw
version: '2.1'
volumes:
  mysql_data: {}
  zm_config: {}
  zm_content: {}

⁠docker cli (click here for more info⁠)

docker run -d \
  --name=zoneminder \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -e ZM_DB_HOST=db \
  -e ZM_DB_NAME=zm \
  -e ZM_DB_PASSWORD=zmpass \
  -e ZM_DB_USER=zmuser \
   -p 3306:3306 \
  -v <path to data>:/config \
  -v <path to content>:/app \
  --restart unless-stopped \
  mattmatician/zoneminder:latest

⁠Parameters

Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

⁠Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

⁠Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here⁠ before asking for support.

⁠User / Group Identifiers

When using volumes (-v flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

⁠Support Info

• Shell access whilst the container is running: docker exec -it zoneminder /bin/bash
• To monitor the logs of the container in realtime: docker logs -f zoneminder
• container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' zoneminder
• image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' mattmatician/zoneminder:latest

⁠Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup⁠ section above to see if it is recommended for the image.

Below are the instructions for updating containers:

⁠Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull zoneminder
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d zoneminder
• You can also remove the old dangling images: docker image prune

⁠Via Docker Run

• Update the image: docker pull mattmatician/zoneminder:latest
• Stop the running container: docker stop zoneminder
• Delete the container: docker rm zoneminder
• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• You can also remove the old dangling images: docker image prune

⁠Via Watchtower auto-updater (only use if you don't remember the original parameters)

• Pull the latest image at its tag and replace it with the same env variables in one run:

  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once zoneminder
  

  Copy

• You can also remove the old dangling images: docker image prune

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose⁠.

⁠Image Update Notifications - Diun (Docker Image Update Notifier)

• We recommend Diun⁠ for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

⁠Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/mattmatician/docker-zoneminder.git
cd docker-zoneminder
docker build \
  --no-cache \
  --pull \
  -t mattmatician/zoneminder:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

⁠Versions

• 29.05.22: - Initial Release.