hotio/scrutiny

GitHub
docker.io / ghcr.io / quay.io
Scrutiny

00

Starting the container¶

cli

docker run --rm \
    --name scrutiny \
    -p 8080:8080 \
    -e PUID=1000 \
    -e PGID=1000 \
    -e UMASK=002 \
    -e TZ="Etc/UTC" \
    -e INTERVAL=86400 \
    -e API_ENDPOINT="http://localhost:8080" \
    -e MODE="both" \
    -v /<host_folder_config>:/config \
    -v /run/udev:/run/udev:ro \
    --cap-add SYS_RAWIO \
    --device /dev/sda \
    cr.hotio.dev/hotio/scrutiny

compose

version: "3.7"

services:
  scrutiny:
    container_name: scrutiny
    image: cr.hotio.dev/hotio/scrutiny
    ports:
      - "8080:8080"
    environment:
      - PUID=1000
      - PGID=1000
      - UMASK=002
      - TZ=Etc/UTC
      - INTERVAL=86400
      - API_ENDPOINT=http://localhost:8080
      - MODE=both
    volumes:
      - /<host_folder_config>:/config
      - /run/udev:/run/udev:ro
    cap_add:
      - SYS_RAWIO
    devices:
      - /dev/sda

For the environment variable MODE you can pick the values both, web or collector to enable the desired operating mode (see below). The INTERVAL variable defines the amount of time in seconds between collector runs, the metrics are pushed to the webinterface located at API_ENDPOINT. When passing through NVMe devices you'll probably have to use --cap-add SYS_ADMIN and/or --cap-add SYS_RAWIO.

Tags¶

Where can I find the source of the image?

You can click the tag name to go to the source on GitHub for that particular tag. Every tag has its own branch. The master branch is used as a landing page and to store some statistics used by this page to populate the table. Temporary tags/branches might not show up in the table, but are also generally not for end-user consumption. Clicking the commit sha brings you to the exact source of that commit.

Tag	Upstream	Version	Commit	Last Updated

Deploying as 2 seperate containers¶

cli

docker run --rm \
    --name scrutiny-collector \
    --network my-net \
    -e INTERVAL=3600 \
    -e API_ENDPOINT="http://scrutiny-web:8080" \
    -e MODE="collector" \
    -v /<host_folder_config>:/config \
    -v /run/udev:/run/udev:ro \
    --cap-add SYS_RAWIO \
    --device /dev/sda \
    cr.hotio.dev/hotio/scrutiny

docker run --rm \
    --name scrutiny-web \
    --network my-net \
    -p 8080:8080 \
    -e MODE="web" \
    -v /<host_folder_config>:/config \
    cr.hotio.dev/hotio/scrutiny

compose

version: "3.7"

services:
  scrutiny-collector:
    container_name: scrutiny-collector
    image: cr.hotio.dev/hotio/scrutiny
    environment:
      - INTERVAL=3600
      - API_ENDPOINT=http://scrutiny-web:8080
      - MODE=collector
    volumes:
      - /<host_folder_config>:/config
      - /run/udev:/run/udev:ro
    cap_add:
      - SYS_RAWIO
    devices:
      - /dev/sda

  scrutiny-web:
    container_name: scrutiny-web
    image: cr.hotio.dev/hotio/scrutiny
    ports:
      - "8080:8080"
    environment:
      - MODE=web
    volumes:
      - /<host_folder_config>:/config