caco3x/storage-analyzer repository overview

⁠Storage Analyzer

This tool uses Duc⁠ to provide a generic Storage Analyzer like provided by Synology⁠ to analyze the storage usage of a system. It's main goal is to to provide a storage usage overview on a NAS, how ever it could also work on any system which provides docker.

See details on https://github.com/caco3/storage-analyzer⁠.

⁠Features

• Included scheduling for automatic scanning
• Single-command deployment
• Very small image footprint
• Web UI to view and manage the snapshots
• Easy navigation through directories and snapshots
• Manual scan trigger
• Log output of the last scan

⁠Usage Examples

⁠With Docker Compose

Use docker-compose.yml⁠.

Run it with

docker compose up --build --detach

⁠Without Docker Compose

docker run -e "SCHEDULE=0 0 * * *" -e "RUN_SCAN_ON_STARTUP=false" \
    -e "EXCLUDE=proc sys dev run tmp temp usr proc" -p 80:80 \
    --mount type=bind,src=/,dst=/scan/root,readonly \
    --mount type=volume,src=duc_database,dst=/database \
    caco3x/storage-analyzer

⁠Parameters

• ⁠SCHEDULE

  A cron-expression that determines when an automatic scan is started.

• ⁠RUN_SCAN_ON_STARTUP

  Set to true if a snapshot should be created on each docker container start

• ⁠EXCLUDE

  Folder/file patterns to be excluded (comma separated list without double quotes).

  Example: proc sys dev run tmp temp usr proc