Suggestion: Documentation Update shm size

[somejavadev]

Currently one may specify the shm size when not using Home Assistant directly in the docker-compose file or docker command line arguments. May I suggest that this option is specified with the default value in the documentation to make the documentation the only place you have to look for updating the value without the need to go and search the docker documentation on how to do this.

Example

docker-compose:

services:
  frigate:
    container_name: frigate
    privileged: true # this may not be necessary for all setups
    restart: unless-stopped
    image: blakeblackshear/frigate:<specify_version_tag>
    shm_size: '64mb'
    devices:
      - /dev/bus/usb:/dev/bus/usb
      - /dev/dri/renderD128 # for intel hwaccel, needs to be updated for your hardware
    volumes:
      - /etc/localtime:/etc/localtime:ro
      - <path_to_config_file>:/config/config.yml:ro
      - <path_to_directory_for_media>:/media/frigate
      - type: tmpfs # Optional: 1GB of memory, reduces SSD/SD Card wear
        target: /tmp/cache
        tmpfs:
          size: 1000000000
    ports:
      - "5000:5000"
      - "1935:1935" # RTMP feeds
    environment:
      FRIGATE_RTSP_PASSWORD: "password"

docker command line:

docker run -d \
  --name frigate \
  --restart=unless-stopped \
  --mount type=tmpfs,target=/tmp/cache,tmpfs-size=1000000000 \
  --device /dev/bus/usb:/dev/bus/usb \
  --device /dev/dri/renderD128 \
  --shm-size=64m \
  -v <path_to_directory_for_media>:/media/frigate \
  -v <path_to_config_file>:/config/config.yml:ro \
  -v /etc/localtime:/etc/localtime:ro \
  -e FRIGATE_RTSP_PASSWORD='password' \
  -p 5000:5000 \
  -p 1935:1935 \
  blakeblackshear/frigate:<specify_version_tag>

The downside to this may be that if the default docker shm size were to change the documentation would be incorrect or if the persons system were to use a different default shm size on their system it might be incorrect.

Another option might be just to mention that it can be increased on the command line or compose file directly.

[ozett]

i guess some clarification on how to use shm-size and tmpfs size would be helpful - in the docs..

#1455 (comment)

[ozett]

doc-update should maybe mention a way to check the configured shm-size (inside the container?)

root@ub20-frigate4:~# docker exec -it frigate /bin/bash
root@5dfd5994f31d:/opt/frigate# df -h
Filesystem      Size  Used Avail Use% Mounted on
overlay         228G   14G  203G   7% /
tmpfs            64M     0   64M   0% /dev
tmpfs           7.3G     0  7.3G   0% /sys/fs/cgroup
shm             1.0G  118M  907M  12% /dev/shm
/dev/sda2       228G   14G  203G   7% /media/frigate
tmpfs           477G  268M  477G   1% /tmp/cache
tmpfs           7.3G   12K  7.3G   1% /proc/driver/nvidia
udev            7.2G     0  7.2G   0% /dev/nvidia0

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[bluearcher-bc]

One thing I am trying to clarify, is the shm_size in docker-compose or docker cli, the result of your calculation times the number of cameras? Also, is the resolution in the calculation based on your main stream or sub-stream resolution?

detect resolution (substream): (640 * 480 * 1.5 * 9 + 270480)/1048576 = 4.213 * 8 cameras = 17.75 shm
main stream resolution: (2560 * 1920 * 1.5 * 9 + 270480)/1048576 = 63.54 * 8 cameras = 508 shm

I am currently expecting that my shm needs to be based on main stream resolution and multiplied by camera count, so 508 in my case?

[bombela]

What does mb mean here?

• 0.001 bits? (millibits, mb). I am pretty sure that's not the one intended.
• 1000 bits? (megabits, Mb)
• 1000 bytes? (megabytes, MB)
• 1024 bytes? (mibibytes, MiB)

[NickM-27]

it means megabytes