Skip to content

Monitoring Setup

Folder monitoring is a feature that can be enabled during installation or when updating the container. Once enabled, there are several features available.

Install or Update

Monitoring runs as a separate process to ensure background operations do not interfere with any manual processing done by the user. In order to support this, folder monitoring must have 2 options configured in the docker-compose.yaml

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
version: '3.9'
services:
    comic-utils:
        image: allaboutduncan/comic-utils-web:latest

        container_name: clu
        logging:
            driver: "json-file"
            options:
                max-size: '20m'  # Reduce log size to 20MB
                max-file: '3'     # Keep only 3 rotated files
        restart: always
        ports:
            - '5577:5577'
        volumes:
            - "/path/to/local/config:/config" # Maps local folder to persist settings
            - "/path/to/local/cache:/cache" # Maps to local folder for DB and thumbnail cache
            ## update the line below to map to your library.
            ## Your library MUST be mapped to '/data' for the app to work
            - "/e/Comics:/data"
            ## Additional folder if you want to use Folder Monitoring.
            - "/f/Downloads:/downloads"
        environment:
            - FLASK_ENV=production
            ## Set to 'yes' if you want to use folder monitoring.
            - MONITOR=yes/no

These options are:

  • Line 22: Secondary volume/location for monitoring
  • Line 26: MONITOR=yes to enable

If you want to enable monitoring and did not configure these on setup, simply stop the container, update your docker-compose.yaml file and restart.

Setup & Requirements

When you have monitoring enabled, you will need to configure a WATCH folder and a TARGET folder.

  • WATCH is the source folder that will be monitored. Files in this location will have automated actions applied to them
  • TARGET is the destination folder where files will be moved as they are processed.