{"id":24627735,"url":"https://github.com/linuxserver-archive/docker-scrutiny","last_synced_at":"2025-10-06T18:30:56.270Z","repository":{"id":37951466,"uuid":"296447739","full_name":"linuxserver-archive/docker-scrutiny","owner":"linuxserver-archive","description":null,"archived":true,"fork":false,"pushed_at":"2022-06-14T18:02:04.000Z","size":105,"stargazers_count":56,"open_issues_count":0,"forks_count":7,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-01-18T22:04:37.207Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/linuxserver-archive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"linuxserver","open_collective":"linuxserver"}},"created_at":"2020-09-17T21:36:55.000Z","updated_at":"2025-01-15T17:20:11.000Z","dependencies_parsed_at":"2022-09-02T19:11:29.911Z","dependency_job_id":null,"html_url":"https://github.com/linuxserver-archive/docker-scrutiny","commit_stats":null,"previous_names":["linuxserver-archive/docker-scrutiny"],"tags_count":106,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxserver-archive%2Fdocker-scrutiny","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxserver-archive%2Fdocker-scrutiny/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxserver-archive%2Fdocker-scrutiny/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linuxserver-archive%2Fdocker-scrutiny/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linuxserver-archive","download_url":"https://codeload.github.com/linuxserver-archive/docker-scrutiny/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235538040,"owners_count":19006076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-25T05:01:40.406Z","updated_at":"2025-10-06T18:30:50.967Z","avatar_url":"https://github.com/linuxserver-archive.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/linuxserver","https://opencollective.com/linuxserver"],"categories":["Dockerfile"],"sub_categories":[],"readme":"\u003c!-- DO NOT EDIT THIS FILE MANUALLY  --\u003e\n\u003c!-- Please read the https://github.com/linuxserver/docker-scrutiny/blob/master/.github/CONTRIBUTING.md --\u003e\n\n[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)\n\n[![Blog](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=Blog)](https://blog.linuxserver.io \"all the things you can do with our containers including How-To guides, opinions and much more!\")\n[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=Discord\u0026logo=discord)](https://discord.gg/YWrKVTn \"realtime support / chat with the community and the team.\")\n[![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026logo=discourse)](https://discourse.linuxserver.io \"post on our community forum.\")\n[![Fleet](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=Fleet)](https://fleet.linuxserver.io \"an online web interface which displays all of our maintained images.\")\n[![GitHub](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=GitHub\u0026logo=github)](https://github.com/linuxserver \"view the source for all of our repositories.\")\n[![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=Supporters\u0026logo=open%20collective)](https://opencollective.com/linuxserver \"please consider helping us by either donating or contributing to our budget\")\n\nThe [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:\n\n* regular and timely application updates\n* easy user mappings (PGID, PUID)\n* custom base image with s6 overlay\n* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth\n* regular security updates\n\nFind us at:\n\n* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!\n* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.\n* [Discourse](https://discourse.linuxserver.io) - post on our community forum.\n* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.\n* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.\n* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget\n\n# DEPRECATION NOTICE\n\nThis image is deprecated. We will not offer support for this image and it will not be updated.\nWe recommend the official images:\nhttps://github.com/AnalogJ/scrutiny#docker\n\n# [linuxserver/scrutiny](https://github.com/linuxserver/docker-scrutiny)\n\n[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fscrutiny?color=94398d\u0026label-color=555555\u0026logo-color=ffffff\u0026style=for-the-badge\u0026package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fscrutiny)\n[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-scrutiny.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026logo=github)](https://github.com/linuxserver/docker-scrutiny)\n[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-scrutiny.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026logo=github)](https://github.com/linuxserver/docker-scrutiny/releases)\n[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=GitHub%20Package\u0026logo=github)](https://github.com/linuxserver/docker-scrutiny/packages)\n[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=GitLab%20Registry\u0026logo=gitlab)](https://gitlab.com/linuxserver.io/docker-scrutiny/container_registry)\n[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=linuxserver.io\u0026message=Quay.io)](https://quay.io/repository/linuxserver.io/scrutiny)\n[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/scrutiny.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=pulls\u0026logo=docker)](https://hub.docker.com/r/linuxserver/scrutiny)\n[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/scrutiny.svg?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=stars\u0026logo=docker)](https://hub.docker.com/r/linuxserver/scrutiny)\n[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-scrutiny%2Fjob%2Fmaster%2F\u0026logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-scrutiny/job/master/)\n[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=CI\u0026query=CI\u0026url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fscrutiny%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/scrutiny/latest/index.html)\n\n[Scrutiny](https://github.com/AnalogJ/scrutiny) WebUI for smartd S.M.A.R.T monitoring. Scrutiny is a Hard Drive Health Dashboard \u0026 Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates from Backblaze.\n\n[![scrutiny](https://raw.githubusercontent.com/AnalogJ/scrutiny/master/docs/dashboard.png)](https://github.com/AnalogJ/scrutiny)\n\n## Supported Architectures\n\nWe utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).\n\nSimply pulling `lscr.io/linuxserver/scrutiny:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.\n\nThe architectures supported by this image are:\n\n| Architecture | Available | Tag |\n| :----: | :----: | ---- |\n| x86-64 | ✅ | amd64-\\\u003cversion tag\\\u003e |\n| arm64 | ✅ | arm64v8-\\\u003cversion tag\\\u003e |\n| armhf| ✅ | arm32v7-\\\u003cversion tag\\\u003e |\n\n## Application Setup\n\nThis container can be run as an 'all-in-one' deployment or as a hub / spoke deployment. Use the environment variables `SCRUTINY_WEB` and `SCRUTINY_COLLECTOR` to control the mode of the container. Setting both to `true` will deploy the container as both a collector and the web UI - this is the simplest and most straightforward deployment approach. To make use of the hub and spoke model, run this container in \"collector\" mode by specifying `SCRUTINY_API_ENDPOINT`. Set this to the host that is running the API. For this to work, you will need to expose the API port directly from the container (by default this is `8080`).\n\nYou may need to manually enter the container to run `scrutiny-collector-metrics run` for your first job or wait until around midnight for it to kick off.\n\nA fully commented example configuration yaml file can be found in the original project repository [here](https://github.com/AnalogJ/scrutiny/blob/master/example.scrutiny.yaml). Place this file in the location mounted to `/config`.\n\nA note on `--cap-add` for this container: \n  * `SYS_RAWIO` is necessary to allow smartctl permission to query your device SMART data.\n  * `SYS_ADMIN` is required for NVMe drives as per upstream issue [#26](https://github.com/AnalogJ/scrutiny/issues/26#issuecomment-696817130).\n\n## Usage\n\nHere are some example snippets to help you get started creating a container.\n\n### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))\n\n```yaml\n---\nversion: \"2.1\"\nservices:\n  scrutiny:\n    image: lscr.io/linuxserver/scrutiny:latest\n    container_name: scrutiny\n    cap_add:\n      - SYS_RAWIO\n      - SYS_ADMIN #optional\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=Europe/London\n      - SCRUTINY_API_ENDPOINT=http://localhost:8080\n      - SCRUTINY_WEB=true\n      - SCRUTINY_COLLECTOR=true\n    volumes:\n      - /path/to/config:/config\n      - /run/udev:/run/udev:ro\n    ports:\n      - 8080:8080\n    devices:\n      - /dev/sda:/dev/sda\n      - /dev/sdb:/dev/sdb\n      - /dev/nvme1n1:/dev/nvme1n1\n    restart: unless-stopped\n```\n\n### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))\n\n```bash\ndocker run -d \\\n  --name=scrutiny \\\n  --cap-add=SYS_RAWIO \\\n  --cap-add=SYS_ADMIN `#optional` \\\n  -e PUID=1000 \\\n  -e PGID=1000 \\\n  -e TZ=Europe/London \\\n  -e SCRUTINY_API_ENDPOINT=http://localhost:8080 \\\n  -e SCRUTINY_WEB=true \\\n  -e SCRUTINY_COLLECTOR=true \\\n  -p 8080:8080 \\\n  -v /path/to/config:/config \\\n  -v /run/udev:/run/udev:ro \\\n  --device /dev/sda:/dev/sda \\\n  --device /dev/sdb:/dev/sdb \\\n  --device /dev/nvme1n1:/dev/nvme1n1 \\\n  --restart unless-stopped \\\n  lscr.io/linuxserver/scrutiny:latest\n```\n\n## Parameters\n\nContainer images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `\u003cexternal\u003e:\u003cinternal\u003e` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.\n\n| Parameter | Function |\n| :----: | --- |\n| `-p 8080` | Port for scrutiny's web interface and API. |\n| `-e PUID=1000` | for UserID - see below for explanation |\n| `-e PGID=1000` | for GroupID - see below for explanation |\n| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |\n| `-e SCRUTINY_API_ENDPOINT=http://localhost:8080` | # optional - API endpoint of the scrutiny UI. Do not change unless using as a remote collector |\n| `-e SCRUTINY_WEB=true` | # optional - Run the web service. |\n| `-e SCRUTINY_COLLECTOR=true` | # optional - Run the metrics collector. |\n| `-v /config` | Where config is stored. |\n| `-v /run/udev:ro` | Provides necessary metadata to Scrutiny. |\n| `--device /dev/sda` | This is how Scrutiny accesses drives. Optionally supply `/dev:/dev` instead for all devices. |\n| `--device /dev/sdb` | A second drive. |\n| `--device /dev/nvme1n1` | An NVMe drive. NVMe requires `--cap-add=SYS_ADMIN`. |\n\n### Portainer notice\n\nThis image utilises `cap_add` or `sysctl` to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.\n\n## Environment variables from files (Docker secrets)\n\nYou can set any environment variable from a file by using a special prepend `FILE__`.\n\nAs an example:\n\n```bash\n-e FILE__PASSWORD=/run/secrets/mysecretpassword\n```\n\nWill set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.\n\n## Umask for running applications\n\nFor all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.\nKeep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.\n\n## User / Group Identifiers\n\nWhen using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.\n\nEnsure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.\n\nIn this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:\n\n```bash\n  $ id username\n    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)\n```\n\n## Docker Mods\n\n[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=scrutiny\u0026query=%24.mods%5B%27scrutiny%27%5D.mod_count\u0026url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=scrutiny \"view available mods for this container.\") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d\u0026labelColor=555555\u0026logoColor=ffffff\u0026style=for-the-badge\u0026label=universal\u0026query=%24.mods%5B%27universal%27%5D.mod_count\u0026url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal \"view available universal mods.\")\n\nWe publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.\n\n## Support Info\n\n* Shell access whilst the container is running: `docker exec -it scrutiny /bin/bash`\n* To monitor the logs of the container in realtime: `docker logs -f scrutiny`\n* container version number\n  * `docker inspect -f '{{ index .Config.Labels \"build_version\" }}' scrutiny`\n* image version number\n  * `docker inspect -f '{{ index .Config.Labels \"build_version\" }}' lscr.io/linuxserver/scrutiny:latest`\n\n## Updating Info\n\nMost of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.\n\nBelow are the instructions for updating containers:\n\n### Via Docker Compose\n\n* Update all images: `docker-compose pull`\n  * or update a single image: `docker-compose pull scrutiny`\n* Let compose update all containers as necessary: `docker-compose up -d`\n  * or update a single container: `docker-compose up -d scrutiny`\n* You can also remove the old dangling images: `docker image prune`\n\n### Via Docker Run\n\n* Update the image: `docker pull lscr.io/linuxserver/scrutiny:latest`\n* Stop the running container: `docker stop scrutiny`\n* Delete the container: `docker rm scrutiny`\n* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)\n* You can also remove the old dangling images: `docker image prune`\n\n### Via Watchtower auto-updater (only use if you don't remember the original parameters)\n\n* Pull the latest image at its tag and replace it with the same env variables in one run:\n\n  ```bash\n  docker run --rm \\\n  -v /var/run/docker.sock:/var/run/docker.sock \\\n  containrrr/watchtower \\\n  --run-once scrutiny\n  ```\n\n* You can also remove the old dangling images: `docker image prune`\n\n**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).\n\n### Image Update Notifications - Diun (Docker Image Update Notifier)\n\n* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.\n\n## Building locally\n\nIf you want to make local modifications to these images for development purposes or just to customize the logic:\n\n```bash\ngit clone https://github.com/linuxserver/docker-scrutiny.git\ncd docker-scrutiny\ndocker build \\\n  --no-cache \\\n  --pull \\\n  -t lscr.io/linuxserver/scrutiny:latest .\n```\n\nThe ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`\n\n```bash\ndocker run --rm --privileged multiarch/qemu-user-static:register --reset\n```\n\nOnce registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.\n\n## Versions\n\n* **13.06.22:** - Deprecate container.\n* **19.01.22:** - Rebase to Alpine 3.15.\n* **22.11.20:** - Added fix for `nsswitch.conf` to resolve local hosts\n* **17.09.20:** - Initial Release.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxserver-archive%2Fdocker-scrutiny","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinuxserver-archive%2Fdocker-scrutiny","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinuxserver-archive%2Fdocker-scrutiny/lists"}