Bot Updating Documentation

images/docker-scrutiny.md

@@ -1,6 +1,9 @@
 ---
 title: scrutiny
 ---
+<!-- DO NOT EDIT THIS FILE MANUALLY  -->
+<!-- Please read the https://github.com/linuxserver/docker-scrutiny/blob/master/.github/CONTRIBUTING.md -->
+
 # [linuxserver/scrutiny](https://github.com/linuxserver/docker-scrutiny)
 
 [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-scrutiny.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-scrutiny)
@@ -29,6 +32,17 @@ The architectures supported by this image are:
 | arm64 | arm64v8-latest |
 | armhf | arm32v7-latest |
 
+## Application Setup
+
+This 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`).
+
+You 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.
+
+A 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`.
+
+A note on `--cap-add` for this container: 
+  * `SYS_RAWIO` is necessary to allow smartctl permission to query your device SMART data.
+  * `SYS_ADMIN` is required for NVMe drives as per upstream issue [#26](https://github.com/AnalogJ/scrutiny/issues/26#issuecomment-696817130).
 
 ## Usage
 
@@ -69,7 +83,7 @@ services:
 
 ### docker cli
 
-```
+```bash
 docker run -d \
   --name=scrutiny \
   --cap-add=SYS_RAWIO \
@@ -90,7 +104,6 @@ docker run -d \
   ghcr.io/linuxserver/scrutiny
 ```
 
-
 ## Parameters
 
 Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` 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.
@@ -101,7 +114,6 @@ Docker images are configured using parameters passed at runtime (such as those a
 | :----: | --- |
 | `8080` | Port for scrutiny's web interface and API. |
 
-
 ### Environment Variables (`-e`)
 
 | Env | Function |
@@ -120,21 +132,21 @@ Docker images are configured using parameters passed at runtime (such as those a
 | `/config` | Where config is stored. |
 | `/run/udev:ro` | Provides necessary metadata to Scrutiny. |
 
-#### Device Mappings (`--device`)
+### Device Mappings (`--device`)
+
 | Parameter | Function |
 | :-----:   | --- |
 | `/dev/sda` | This is how Scrutiny accesses drives. Optionally supply `/dev:/dev` instead for all devices. |
 | `/dev/sdb` | A second drive. |
 | `/dev/nvme1n1` | An NVMe drive. NVMe requires `--cap-add=SYS_ADMIN`. |
 
-
 ## Environment variables from files (Docker secrets)
 
 You can set any environment variable from a file by using a special prepend `FILE__`.
 
 As an example:
 
-```
+```bash
 -e FILE__PASSWORD=/run/secrets/mysecretpassword
 ```
 
@@ -145,7 +157,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
 For 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.
 Keep 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.
 
-
 ## User / Group Identifiers
 
 When 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`.
@@ -154,30 +165,17 @@ Ensure any volume directories on the host are owned by the same user you specify
 
 In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
 
-```
+```bash
   $ id username
     uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
 ```
 
-## Application Setup
-
-This 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`).
-
-You 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.
-
-A 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`.
-
-A note on `--cap-add` for this container: 
-  * `SYS_RAWIO` is necessary to allow smartctl permission to query your device SMART data.
-  * `SYS_ADMIN` is required for NVMe drives as per upstream issue [#26](https://github.com/AnalogJ/scrutiny/issues/26#issuecomment-696817130). 
-
-
 ## Docker Mods
+
 [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=scrutiny&query=%24.mods%5B%27scrutiny%27%5D.mod_count&url=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&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
 
 We 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.
 
-
 ## Support Info
 
 * Shell access whilst the container is running: