From d7b45e5f018b8442176faf2325735deed7116ae3 Mon Sep 17 00:00:00 2001 From: Jason Kulatunga Date: Wed, 12 Oct 2022 20:58:41 -0700 Subject: [PATCH] update docs. --- docs/SUPPORTED_NAS_OS.md | 3 ++- docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md | 10 +++++++--- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/SUPPORTED_NAS_OS.md b/docs/SUPPORTED_NAS_OS.md index aae1e52..b20d3e3 100644 --- a/docs/SUPPORTED_NAS_OS.md +++ b/docs/SUPPORTED_NAS_OS.md @@ -11,8 +11,9 @@ in `docs/guides/` or elsewhere) it will be linked here. - [ ] OMV - [ ] Amahi - [ ] Running in a LXC container -- [x] [PFSense](./INSTALL_UNRAID.md) +- [x] [PFSense](./INSTALL_PFSENSE.md) - [x] QNAP - [x] [RockStor](https://rockstor.com/docs/interface/docker-based-rock-ons/scrutiny.html) - [ ] Solaris/OmniOS CE Support - [ ] Kubernetes +- [x] [Windows](./INSTALL_MANUAL_WINDOWS.md) diff --git a/docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md b/docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md index d512aee..6c62a01 100644 --- a/docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md +++ b/docs/TROUBLESHOOTING_DEVICE_COLLECTOR.md @@ -61,7 +61,8 @@ using a collector config file. See [example.collector.yaml](/example.collector.y > NOTE: If you use docker, you **must** pass though the RAID virtual disk to the container using `--device` (see below) > -> This device may be in `/dev/*` or `/dev/bus/*`. +> This device may be in `/dev/*` or `/dev/bus/*`. +> If you do not see a virtual device file `/dev/bus/*` you may need to use the `--privileged` flag. See [#366 for more info](https://github.com/AnalogJ/scrutiny/issues/366#issuecomment-1253196407) > > If you're unsure, run `smartctl --scan` on your host, and pass all listed devices to the container. @@ -92,7 +93,7 @@ devices: type: - aacraid,0,0,0 - aacraid,0,0,1 - + # HPE Smart Array example: https://github.com/AnalogJ/scrutiny/issues/213 - device: /dev/sda type: @@ -100,8 +101,11 @@ devices: - 'cciss,1' ``` +> + ### NVMe Drives -As mentioned in the [README.md](/README.md), NVMe devices require both `--cap-add SYS_RAWIO` and `--cap-add SYS_ADMIN` + +As mentioned in the [README.md](/README.md), NVMe devices require both `--cap-add SYS_RAWIO` and `--cap-add SYS_ADMIN` to allow smartctl permission to query your NVMe device SMART data [#26](https://github.com/AnalogJ/scrutiny/issues/26) When attaching NVMe devices using `--device=/dev/nvme..`, make sure to provide the device controller (`/dev/nvme0`)