coppit/inotify-command

docker-inotify-command 镜像文档

镜像概述和主要用途

docker-inotify-command是一个用于监控目录变化并触发指定命令的Docker容器。它支持同时监控多个目录，可通过配置控制命令执行频率，适用于需要基于文件变化自动执行操作的场景，如权限修复、媒体库扫描、自动化脚本运行等。

核心功能和特性

• 目录监控：实时监控指定目录的文件变化
• 多目录支持：最多可同时监控20个不同目录
• 命令触发：检测到目录变化时自动执行配置的命令
• 执行频率控制：通过稳定时间、最小周期等参数避免命令频繁执行
• 权限管理：支持通过环境变量和配置文件控制文件所有权和权限
• 灵活配置：通过配置文件自定义监控行为和命令参数

使用场景和适用范围

• 文件系统变化触发自动化脚本执行
• 媒体文件更新时自动触发媒体服务器扫描
• 配置文件变更后自动重启服务
• 目录内容变化时自动修复文件权限
• 开发环境中代码变更后自动构建或测试

使用方法和配置说明

基本使用

拉取并运行容器

该镜像已发布为Docker可信构建，可直接拉取使用：

bash
sudo docker run --name=inotify-command -d \
  -v /etc/localtime:/etc/localtime \
  -v /path/to/config/dir:/config:rw \
  -v /path/to/monitor/dir:/dir1 \
  coppit/inotify-command

查看容器状态

bash
docker logs inotify-command

配置文件设置

首次运行

首次运行容器时，会在配置目录（/config）生成sample.conf文件，然后容器会退出。需重命名该文件（如monitor1.conf）并编辑配置参数。

配置参数说明

配置文件支持以下参数：

多目录监控

创建多个配置文件（如monitor1.conf、monitor2.conf）即可监控多个目录，需确保每个配置文件中的WATCH_DIR对应不同的容器内路径（如/dir1、/dir2），并在运行容器时通过-v参数映射相应的宿主机目录。

文件所有权控制

UMAP和GMAP环境变量

若命令需要修改宿主机文件，可通过UMAP和GMAP环境变量映射容器内用户/组ID与宿主机一致：

• UMAP：用户映射，格式为用户名:宿主机用户ID:宿主机组ID，多个用户用空格分隔
• GMAP：组映射，格式为组名:宿主机组ID，多个组用空格分隔

示例：

bash
docker run -e UMAP="nobody:99:100 www:80:800" -e GMAP="users:100 wheel:800" ...

USER_ID、GROUP_ID和UMASK配置

对于没有显式指定用户/组的命令，可在配置文件中设置：

• USER_ID：执行命令的用户ID（应与宿主机用户ID一致）
• GROUP_ID：执行命令的组ID（应与宿主机组ID一致）
• UMASK：文件创建权限掩码（可通过su -l 用户名 -c umask在宿主机查看）

使用示例

示例1：目录变化时修复权限

配置文件（permfix.conf）：

ini
WATCH_DIR=/dir2
SETTLE_DURATION=5
MAX_WAIT_TIME=30
MIN_PERIOD=30
COMMAND="/root/newperms /dir2"
USER_ID=0
GROUP_ID=0
UMASK=0000
IGNORE_EVENTS_WHILE_COMMAND_IS_RUNNING=1
USE_POLLING=no

运行容器：

bash
docker run -e UMAP=nobody:99:100 -e GMAP=users:100 --name=inotify-command -d \
  -v /etc/localtime:/etc/localtime \
  -v /path/to/config:/config:rw \
  -v /path/to/monitor:/dir2:rw \
  -v /usr/local/sbin/newperms:/root/newperms \
  coppit/inotify-command

示例2：媒体目录变化时触发SageTV扫描

配置文件（sagetv.conf）：

ini
WATCH_DIR=/dir1
SETTLE_DURATION=5
MAX_WAIT_TIME=05:00
MIN_PERIOD=10:00
COMMAND="wget -nv -O /dev/null --auth-no-challenge http://sage:frey@192.168.1.102:8080/sagex/api?c=RunLibraryImportScan&1="
USER_ID=0
GROUP_ID=0
UMASK=0000
IGNORE_EVENTS_WHILE_COMMAND_IS_RUNNING=0
USE_POLLING=no

运行容器：

bash
docker run --name=inotify-command -d \
  -v /etc/localtime:/etc/localtime \
  -v /path/to/config:/config:rw \
  -v /path/to/media:/dir1 \
  coppit/inotify-command